Skip to content

Commit c57e032

Browse files
authored
DOCS: Add front page cards for supported and external model implementations (#1012)
* Update front page of docs [makedocs] * formating [makedocs] * re-format [makedocs] * clean up [makedocs] * clarify language [makedocs] * add oregon
1 parent ed44a40 commit c57e032

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

docs/_static/theme_overrides.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ div.sd-card-header {
88
font-weight: 800;
99
var(--pst-font-family-base);
1010
}
11+
12+
div.sd-card {
13+
margin-bottom: 20px;
14+
}

docs/index.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,40 @@ the development and management of the ActivitySim is on the `project site <http:
3333
Start here to learn about developing ActivitySim, including creating
3434
model components, or changing the codebase.
3535

36+
.. grid-item-card::
37+
38+
:fa:`thumbs-up` |nbsp| |nbsp| Consortium Supported Examples
39+
40+
^^^
41+
42+
The ActivitySim consortium actively supports two example models, each of which
43+
can be used as a starting point (i.e. a "donor model") for new implementations.
44+
45+
- The `MTC Example <https://github.com/ActivitySim/activitysim-prototype-mtc>`__,
46+
our one-zone system prototype. This example is originally based on MTC's Travel Model One (TM1),
47+
but has evolved to be a slightly different model.
48+
- The `SANDAG Example <https://github.com/ActivitySim/sandag-abm3-example>`__,
49+
our two-zone system model. Some effort has been made to keep it aligned
50+
with SANDAG's model, but it is not an exact copy of SANDAG's production model.
51+
52+
.. grid-item-card::
53+
54+
:fa:`square-arrow-up-right` |nbsp| |nbsp| Member Agency Models
55+
56+
^^^
57+
58+
Several consortium member agencies have open-sourced their ActivitySim
59+
implementations. These open models may or may not be complete calibrated
60+
tools. Unless clearly marked, users should not assume that mlinked models are
61+
"official" implementations used for policy analysis; public agencies often
62+
publish in-progress model development to foster collaboration and transparency.
63+
Contact the agencies directly with questions.
64+
65+
- `Puget Sound Regional Commission <https://github.com/psrc/psrc_activitysim>`__ (Seattle)
66+
- `Atlanta Regional Commission <https://github.com/atlregional/arc-activitysim>`__
67+
- `Metropolitan Council <https://github.com/Metropolitan-Council/metc-asim-model/tree/main/source/activitysim>`__ (Minneapolis-St. Paul)
68+
- `Oregon Modeling Statewide Collaborative <https://github.com/OrMSC/SimOR>`__
69+
3670
.. toctree::
3771
:hidden:
3872

0 commit comments

Comments
 (0)