Skip to content

Commit

Permalink
Add installation and usage notes
Browse files Browse the repository at this point in the history
  • Loading branch information
invisibleroads committed Dec 23, 2016
1 parent 2f5a619 commit 2d43085
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
76 changes: 75 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,77 @@
Infrastructure Planning
=======================
Here are composable modules for planning infrastructure.
Here is an updated infrastructure planning system based on `our earlier work <https://github.com/SEL-Columbia/networkplanner>`_.


Install
-------
The system depends on several numerical and spatial packages. You can use the following scripts to install these packages. ::

git clone https://github.com/crosscompute/crosscompute-environments-ansible
cd crosscompute-environments-ansible
bash setup.sh

Additional required modules must be installed manually. Note that you may need to edit ``requirements.txt`` to exclude certain packages.::

source ~/.virtualenvs/crosscompute/bin/activate

git clone https://github.com/sel-columbia/networker
pushd networker
vim requirements.txt
numpy
scipy
networkx
decorator
cython
nose
funcsigs
pandas
enum34
pytz
rtree
jsonschema
pyproj
six
# gdal
pip install -e .
popd

git clone https://github.com/sel-columbia/sequencer
pushd sequencer
vim requirements.txt
scipy
# dateutil
decorator
fiona
# freetype
# gdal
matplotlib
networkx
numexpr
pandas
pyparsing
pytz
numpy
pip install -e .
popd

git clone https://github.com/sel-columbia/infrastructure-planning
pushd infrastructure-planning
pip install -e .
popd


Use
---
Run example scenario. ::

bash scripts/estimate_electricity_cost_by_technology_from_population.sh

Serve notebook. ::

source ~/.virtualenvs/crosscompute/bin/activate
crosscompute serve compute_levelized_cost_per_kwh_consumed.ipynb

Start server. ::

bash scripts/serve.sh
1 change: 0 additions & 1 deletion scripts/update.sh

This file was deleted.

0 comments on commit 2d43085

Please sign in to comment.