license, contribution, todo, etc

astyonax · Oct 23, 2017 · 2198241 · 2198241
1 parent 7d49180
commit 2198241
Show file tree

Hide file tree

Showing 49 changed files with 75 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+*.pkl
+*.pdpkl
+*.pyc
+*.key
+.ipynb_checkpoints/*
+.cache/*
+citymapper/*
+.nogit
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing
+
+By participating in this project, you
+agree to abide by the [code of conduct].
+
+[code of conduct]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.md
+
+Issues are well accepted, as well as pull requests with edits on README.md.
+For different ideas, get in contact first if you want to issue a pull request.
+
+Fork, then clone the repo:
+
+    git clone git@github.com:your-username/factory_bot_rails.git
+
+
+The repository does not contain the raw data (because I don't know it's license yet).
+As consequence, if you want to work on the code, you need to run the `TimingParis.py` script for few days first.
+
+Make your changes.
+
+Push to your fork and [submit a pull request][pr]:
+
+[pr]: https://github.com/thoughtbot/factory_bot_rails/compare/
+
+1. Do not include any data file. Only code, and plots.
+2. Write a [good commit message][commit].
+
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,2 @@
+# License
+The movies, animation, plots, and texts (said the content) of this project are licensed under the [Creative Commons Attribution Share Alike 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license, and the underlying source code used to analyze, format, render, and display that content is licensed under the [GNU GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.
diff --git a/README.md b/README.md
@@ -241,7 +241,7 @@ I showed that
 
 6. The Seine is a barrier for bikes, but not for cars.
 
-7. In comparison to mobility within the city,  the suburbs strongly disadvantage bicycling. Is there an official figure of number of trips by means of transport? 
+7. In comparison to mobility within the city,  the suburbs strongly disadvantage bicycling. Is there an official figure of number of trips by means of transport?
 
 2. Comparing the attractors of the  bicycling network inside Paris, with the Plan Velo 2015-2020 we can see some overlap; but the overlap is not perfect. More seems needed to support bicycling right outside of Paris.
 
@@ -270,7 +270,7 @@ Since I used Google's data and routing engine, I don't have full control of the
 
 The plot above shows that the average distance of departure points is 100 m and 150 m inside and outside Paris, respectively.
 
-### Transit 
+### Transit
 ![plots/inside_timing.png](plots/inside_timing_full.png  "ETA for trips inside Paris")
 
 *`Data:` Google Maps -- `Period:` February - April 2017 -- `# of trips:` ~21690 -- `Code`: [Time Paris](notebooks/TimeParis.ipynb)*
@@ -330,3 +330,6 @@ Although with the current protocol transit time is, at worst, just 15 min slower
 * [2][ETA -- co2 production by bike](https://www.eta.co.uk/2011/12/13/co2-emissions-from-cycling-revealed/)
 * [OpenData RATP](https://data.ratp.fr/explore/dataset/trafic-annuel-entrant-par-station-du-reseau-ferre-2014/)
 * [Air pollution in Paris](https://www.airparif.asso.fr/#)
+
+# License
+The movies, animation, plots, and texts (said the content) of this project are licensed under the [Creative Commons Attribution Share Alike 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license, and the underlying source code used to gather, collect, analyze, format, render, and display that content is licensed under the [GNU GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,15 @@
+# TODO
+
+## Report
+
+1. Do TODOs listed in README.md
+
+## Documentation
+
+1. Write doc for scripts/TimeParis.py and sync with RaspberryPi version
+2. Document lib/
+
+## Code
+
+1. Make lib for plotting
+2. Make lib of common code in notebooks
diff --git a/plots/average_distance.png b/plots/average_distance.png
diff --git a/plots/bigpar_DTDS.png b/plots/bigpar_DTDS.png
diff --git a/plots/bigpar_attractor.png b/plots/bigpar_attractor.png
diff --git a/plots/bigpar_cfg.png b/plots/bigpar_cfg.png
diff --git a/plots/bigpar_cfg_no.png b/plots/bigpar_cfg_no.png
diff --git a/plots/bigpar_cluster_bike.png b/plots/bigpar_cluster_bike.png
diff --git a/plots/bigpar_clusters.png b/plots/bigpar_clusters.png
diff --git a/plots/bigpar_hist_dist_mode.png b/plots/bigpar_hist_dist_mode.png
diff --git a/plots/bigpar_hist_kgco2_mode.png b/plots/bigpar_hist_kgco2_mode.png
diff --git a/plots/bigpar_p1_p2_hist.png b/plots/bigpar_p1_p2_hist.png
diff --git a/plots/bigpar_timing.png b/plots/bigpar_timing.png
diff --git a/plots/bigpar_timing_full.png b/plots/bigpar_timing_full.png
diff --git a/plots/departure_points.png b/plots/departure_points.png
diff --git a/plots/inside_DTDS.png b/plots/inside_DTDS.png
diff --git a/plots/inside_attractor.png b/plots/inside_attractor.png
diff --git a/plots/inside_betweeness.png b/plots/inside_betweeness.png
diff --git a/plots/inside_betweeness_convenient_network.png b/plots/inside_betweeness_convenient_network.png
diff --git a/plots/inside_bike_clusters.png b/plots/inside_bike_clusters.png
diff --git a/plots/inside_car_clusters.png b/plots/inside_car_clusters.png
diff --git a/plots/inside_cfg.png b/plots/inside_cfg.png
diff --git a/plots/inside_cfg_no.png b/plots/inside_cfg_no.png
diff --git a/plots/inside_cluster_bike.png b/plots/inside_cluster_bike.png
diff --git a/plots/inside_clusters.png b/plots/inside_clusters.png
diff --git a/plots/inside_hist_dist_mode.png b/plots/inside_hist_dist_mode.png
diff --git a/plots/inside_hist_kgco2_mode.png b/plots/inside_hist_kgco2_mode.png
diff --git a/plots/inside_p1_p2_hist.png b/plots/inside_p1_p2_hist.png
diff --git a/plots/inside_timing.png b/plots/inside_timing.png
diff --git a/plots/inside_timing_full.png b/plots/inside_timing_full.png
diff --git a/plots/outin_DTDS.png b/plots/outin_DTDS.png
diff --git a/plots/outin_attractor.png b/plots/outin_attractor.png
diff --git a/plots/outin_betweeness.png b/plots/outin_betweeness.png
diff --git a/plots/outin_betweeness_convenient_network.png b/plots/outin_betweeness_convenient_network.png
diff --git a/plots/outin_bike_clusters.png b/plots/outin_bike_clusters.png
diff --git a/plots/outin_car_clusters.png b/plots/outin_car_clusters.png
diff --git a/plots/outin_cfg.png b/plots/outin_cfg.png
diff --git a/plots/outin_cfg_no.png b/plots/outin_cfg_no.png
diff --git a/plots/outin_cluster_bike.png b/plots/outin_cluster_bike.png
diff --git a/plots/outin_clusters.png b/plots/outin_clusters.png
diff --git a/plots/outin_hist_dist_mode.png b/plots/outin_hist_dist_mode.png
diff --git a/plots/outin_hist_kgco2_mode.png b/plots/outin_hist_kgco2_mode.png
diff --git a/plots/outin_p1_p2_hist.png b/plots/outin_p1_p2_hist.png
diff --git a/plots/outin_timing.png b/plots/outin_timing.png
diff --git a/plots/outin_timing_full.png b/plots/outin_timing_full.png
diff --git a/plots_summary.md b/plots_summary.md
@@ -1,7 +1,7 @@
 # Plots Summary
 
 This is a self-generated list of the available plots
-**Dated:** *20, Oct 2017 @ 18:42*
+**Dated:** *23, Oct 2017 @ 23:33*
 
 
 ![plots/average_distance.png](plots/average_distance.png  "plots/average_distance.png")
@@ -48,6 +48,14 @@ This is a self-generated list of the available plots
 *plots/bigpar_timing.png*
 ---
 
+![plots/bigpar_timing_full.png](plots/bigpar_timing_full.png  "plots/bigpar_timing_full.png")
+*plots/bigpar_timing_full.png*
+---
+
+![plots/departure_points.png](plots/departure_points.png  "plots/departure_points.png")
+*plots/departure_points.png*
+---
+
 ![plots/inside_DTDS.png](plots/inside_DTDS.png  "plots/inside_DTDS.png")
 *plots/inside_DTDS.png*
 ---
@@ -104,6 +112,10 @@ This is a self-generated list of the available plots
 *plots/inside_timing.png*
 ---
 
+![plots/inside_timing_full.png](plots/inside_timing_full.png  "plots/inside_timing_full.png")
+*plots/inside_timing_full.png*
+---
+
 ![plots/outin_DTDS.png](plots/outin_DTDS.png  "plots/outin_DTDS.png")
 *plots/outin_DTDS.png*
 ---
@@ -160,3 +172,7 @@ This is a self-generated list of the available plots
 *plots/outin_timing.png*
 ---
 
+![plots/outin_timing_full.png](plots/outin_timing_full.png  "plots/outin_timing_full.png")
+*plots/outin_timing_full.png*
+---
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# License
		The movies, animation, plots, and texts (said the content) of this project are licensed under the [Creative Commons Attribution Share Alike 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license, and the underlying source code used to analyze, format, render, and display that content is licensed under the [GNU GPLv3](http://www.gnu.org/licenses/gpl-3.0.txt) license.