From 1a5f2bff539b72137363c4d8b5b675c520142196 Mon Sep 17 00:00:00 2001 From: Sam Maurer Date: Wed, 13 Feb 2019 15:05:35 -0800 Subject: [PATCH] Updating docs --- README.md | 3 ++- docs/source/getting-started.rst | 7 +++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9ecadd2..156acb1 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ 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 @@ -17,6 +17,7 @@ pip install urbansim_templates ``` conda install urbansim_templates --channel conda-forge +conda install urbansim --channel udst ``` ### Documentation diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 2d37be3..8f39858 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -18,7 +18,9 @@ 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 `__ for UrbanSim Templates projects. @@ -26,7 +28,7 @@ UrbanSim Templates has been tested with Python versions 2.7, 3.5, and 3.6. Insta 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 @@ -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 `__, `Pandas `__, and `Statsmodels `__, plus two other UDST libraries: `Orca `__ and `ChoiceModels `__. These will be included automatically when you install UrbanSim Templates.