Skip to content

Commit

Permalink
Merge pull request #90 from synthicity/install-docs
Browse files Browse the repository at this point in the history
Install docs
  • Loading branch information
jiffyclub committed Aug 7, 2014
2 parents f6b0396 + 9ebb236 commit ee551ba
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/gettingstarted.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Getting Started
===============

Installation
------------

Anaconda
~~~~~~~~

UrbanSim is a Python library that uses a number of packages from the
scientific Python ecosystem.
The easiest way to get your own scientific Python installation is to
install `Anaconda <http://docs.continuum.io/anaconda/index.html>`_,
which contains most of the libraries upon which UrbanSim depends.

UrbanSim
~~~~~~~~

UrbanSim can be installed from our
`development repository <https://github.com/synthicity/urbansim>`_
using `pip <https://pip.pypa.io/en/latest/>`_, a Python package manager.
pip is included with Anaconda so you should now be able to open a terminal
and run the following command to install UrbanSim::

pip install -U https://github.com/synthicity/urbansim/archive/master.zip

This will download urbansim and install the remaining dependencies not
included in Anaconda.

If you need to update UrbanSim run the above command again.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Contents
.. toctree::
:maxdepth: 2

gettingstarted
sim/index
models/index
developer/index
Expand Down

0 comments on commit ee551ba

Please sign in to comment.