diff --git a/.travis.yml b/.travis.yml index 1f3b25cb7..ce272981e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -44,6 +44,7 @@ jobs: - stage: Deployment name: Documentation + env: TEST_ENV="activitysim-test-larch" script: - coveralls # Build docs diff --git a/docs/development.rst b/docs/development.rst index 2794f15bf..00a7dac22 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -357,7 +357,7 @@ Generally speaking, there are two types of ActivitySim examples: test examples a examples are :ref:`example_mtc`, :ref:`example_estimation`, :ref:`example_multiple_zones`, and :ref:`example_marin`. These examples are owned and maintained by the project. * Agency examples - these are agency partner model implementations currently being setup. The current agency examples - are :ref:`example_arc`, :ref:`example_semcog`, :ref:`example_psrc`, and :ref:`example_sandag`. These examples can be + are :ref:`example_arc`, :ref:`example_semcog`, :ref:`example_psrc`, :ref:`example_sandag`, and :ref:`example_sandag_xborder`. These examples can be configured in ways different from the test examples, include new inputs and expressions, and may include new planned software components for contribution to ActivitySim. These examples are owned by the agency. diff --git a/docs/examples.rst b/docs/examples.rst index bcb3a9fed..5986f46df 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -28,7 +28,7 @@ This page describes the example models included with ActivitySim. The current e +---------------------------------+-----------------------------------------------------------+--------------+----------------------+ | :ref:`example_sandag` | SANDAG agency example | 3 | In development | +---------------------------------+-----------------------------------------------------------+--------------+----------------------+ -| :ref:`example_sandag_xborder` | SANDAG agency example | 3 | In development | +| :ref:`example_sandag_xborder` | SANDAG agency example | 3 | In development | +---------------------------------+-----------------------------------------------------------+--------------+----------------------+ .. note:: @@ -1514,10 +1514,10 @@ Example See example commands in `example_manifest.yaml `_ for running example_sandag. For optimal performance, configure multiprocessing and chunk_size based on machine hardware. -.. _example_sandag : +.. _example_sandag_xborder : example_sandag_xborder --------------- +---------------------- .. note:: diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst index 7e21e062d..6e2370062 100644 --- a/docs/gettingstarted.rst +++ b/docs/gettingstarted.rst @@ -74,11 +74,15 @@ tools for certain development tasks:: conda install jupyterlab matplotlib geopandas descartes -c conda-forge --override-channels -n asim To create an environment containing all these optional dependencies at once, you -can run the shortcut command:: +can run the shortcut command + +:: conda env create activitysim/ASIM -n asim -4. To use the **asim** environment, you need to activate it:: +4. To use the **asim** environment, you need to activate it + +:: conda activate asim