Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
smmaurer committed Feb 13, 2019
1 parent 167ffb2 commit 1a5f2bf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ UrbanSim Templates is a Python library that provides building blocks for Orca-ba
The library contains templates for common types of model steps, plus a tool called ModelManager that runs as an extension to the [Orca](https://udst.github.io/orca) task orchestrator. ModelManager can register template-based model steps with the orchestrator, save them to disk, and automatically reload them for future sessions. The package was developed to make it easier to set up new simulation models — model step templates reduce the need for custom code and make settings more portable between models.

### Installation
UrbanSim Templates can be installed using the Pip or Conda package managers:
UrbanSim Templates can be installed using the Pip or Conda package managers. With Conda, you (currently) need to install UrbanSim separately; Pip will handle this automatically.

```
pip install urbansim_templates
```

```
conda install urbansim_templates --channel conda-forge
conda install urbansim --channel udst
```

### Documentation
Expand Down
7 changes: 5 additions & 2 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,17 @@ UrbanSim Templates was created in 2018 by Sam Maurer (maurer@urbansim.com), who
Installation
------------

UrbanSim Templates has been tested with Python versions 2.7, 3.5, and 3.6. Installation in Python 3.7 is currently blocked by Orca's PyTables requirement.
UrbanSim Templates is tested with Python versions 2.7, 3.5, 3.6, and 3.7.

As of Feb. 2019, there is an installation problem in Python 3.7 when using Pip (because of an issue with Orca's PyTables dependency). Conda should work.

.. note::
It can be helpful to set up a dedicated Python environment for each project you work on. This lets you use a stable and replicable set of libraries that won't be affected by other projects. Here are some good `environment settings <https://gist.github.com/smmaurer/f3a4f424a4aa877fb73e1cb2567bd89d>`__ for UrbanSim Templates projects.

Production releases
~~~~~~~~~~~~~~~~~~~

UrbanSim Templates can be installed using the Pip or Conda package managers.
UrbanSim Templates can be installed using the Pip or Conda package managers. With Conda, you (currently) need to install UrbanSim separately; Pip will handle this automatically.

.. code-block:: python
Expand All @@ -35,6 +37,7 @@ UrbanSim Templates can be installed using the Pip or Conda package managers.
.. code-block:: python
conda install urbansim_templates --channel conda-forge
conda install urbansim --channel udst
Dependencies include `NumPy <http://numpy.org>`__, `Pandas <http://pandas.pydata.org>`__, and `Statsmodels <http://statsmodels.org>`__, plus two other UDST libraries: `Orca <http://udst.github.io/orca>`__ and `ChoiceModels <http://github.com/udst/choicemodels>`__. These will be included automatically when you install UrbanSim Templates.

Expand Down

0 comments on commit 1a5f2bf

Please sign in to comment.