Electricitymap-contrib: Improve developer documentation

[systemcatch]

Few points to start with, feel free to add more.

• Getting nodejs installed and working correctly. :sob:
• Installing python 3, Windows does not ship with it by default I think.
• Can topogen.sh be run on powershell or does it require bash for Windows?

[corradio]

In principle that's why all of this should be done inside Docker. It simplifies things quite significantly! Although Docker can be a bit annoying to install..

[jbuverud]

We could add something about docker's system requirements. It only runs on certain versions of windows 10 (does not run on Home editions, for instance). I had to resort to running it through a VM install on my laptop.

[systemcatch]

@corradio That was my idea initially but afaik docker only works when building the map. To add new geometries you have to have a working node install.

Yes it would be nice to add something about using docker on windows. I know @alixunderplatz is currently trying to get the map built on his Windows machine but is having difficulties.

[corradio]

Actually I think we made the changes required to be able to do all the
mapping inside the container.
It's not really documented though.

On Wed, Apr 11, 2018 at 5:44 PM, Chris [e-mail] wrote:

@corradio https://github.com/corradio That was my idea initially but
afaik docker only works when building the map. To add new geometries you
have to have a working node install.

Yes it would be nice to add something about using docker on windows. I
know @alixunderplatz https://github.com/alixunderplatz is currently
trying to get the map built on his Windows machine but is having
difficulties.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/tmrowco/electricitymap/issues/1322#issuecomment-380499917,
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABlEKIhLYsZfkqRJRyUtIAs8VSIBfUtVks5tniTLgaJpZM4TOqZ6
.

[systemcatch]

@corradio if you can give me a rough guide to mapping in the container I will add a more polished version to the docs.

[corradio]

I think it's as simple as docker-compose run --rm web ./topogen.sh but haven't tried it

[corradio]

@systemcatch did it work?

[systemcatch]

Running it on my machine worked. To be sure we'd need to run this on a fresh VM but it's a good sign. @jbuverud fancy having a go?

(EM-env) chris@ThinkPad:~/electricitymap$ docker-compose run --rm web ./topogen.sh
Starting electricitymap_mockserver_1 ... 
Starting electricitymap_mockserver_1 ... done
Downloading ne_10m_admin_0_map_subunits.zip
Warning: Illegal date format for -z, --timecond (and not a file name). 
Warning: Disabling time condition. See curl_getdate(3) for valid date syntax.
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 5324k  100 5324k    0     0   157k      0  0:00:33  0:00:33 --:--:--    92
Archive:  build/ne_10m_admin_0_map_subunits.zip
  inflating: build/ne_10m_admin_0_map_subunits.README.html  
 extracting: build/ne_10m_admin_0_map_subunits.VERSION.txt  
 extracting: build/ne_10m_admin_0_map_subunits.cpg  
  inflating: build/ne_10m_admin_0_map_subunits.dbf  
  inflating: build/ne_10m_admin_0_map_subunits.prj  
  inflating: build/ne_10m_admin_0_map_subunits.shp  
  inflating: build/ne_10m_admin_0_map_subunits.shx  
Downloading ne_10m_admin_1_states_provinces_lakes.zip
Warning: Illegal date format for -z, --timecond (and not a file name). 
Warning: Disabling time condition. See curl_getdate(3) for valid date syntax.
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 13.6M  100 13.6M    0     0   241k      0  0:00:58  0:00:58 --:--:--  245k
Archive:  build/ne_10m_admin_1_states_provinces_lakes.zip
  inflating: build/ne_10m_admin_1_states_provinces_lakes.README.html  
 extracting: build/ne_10m_admin_1_states_provinces_lakes.VERSION.txt  
 extracting: build/ne_10m_admin_1_states_provinces_lakes.cpg  
  inflating: build/ne_10m_admin_1_states_provinces_lakes.dbf  
  inflating: build/ne_10m_admin_1_states_provinces_lakes.prj  
  inflating: build/ne_10m_admin_1_states_provinces_lakes.shp  
  inflating: build/ne_10m_admin_1_states_provinces_lakes.shx  
Extract metadata
Parsing countries..
Parsing states..
Parsing 3rd party..
Done

[corradio]

@systemcatch seems clean. Fancy doing a PR to update the doc and close this issue?