-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #90 from UDST/fixes-for-readthedocs
Moving documentation builds from Github Pages to Read the Docs
- Loading branch information
Showing
110 changed files
with
41 additions
and
36,732 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,28 @@ | ||
[![Build Status](https://travis-ci.org/UDST/urbansim_templates.svg?branch=master)](https://travis-ci.org/UDST/urbansim_templates) | ||
[![Coverage Status](https://coveralls.io/repos/github/UDST/urbansim_templates/badge.svg?branch=master)](https://coveralls.io/github/UDST/urbansim_templates?branch=master) | ||
[![Docs Status](https://readthedocs.org/projects/urbansim_templates/badge/?version=latest)](http://docs.udst.org/projects/urbansim-templates/en/latest) | ||
|
||
# UrbanSim Templates | ||
|
||
UrbanSim Templates is a Python library that provides building blocks for Orca-based simulation models. It’s part of the Urban Data Science Toolkit. | ||
UrbanSim Templates is a Python library that provides building blocks for Orca-based simulation models. It's part of the [Urban Data Science Toolkit](http://docs.udst.org) (UDST). | ||
|
||
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 and documentation | ||
### Installation | ||
UrbanSim Templates can be installed using the Pip or Conda package managers: | ||
|
||
See the online documentation for installation, usage, and full API: https://udst.github.io/urbansim_templates/ | ||
``` | ||
pip install urbansim_templates | ||
``` | ||
|
||
``` | ||
conda install urbansim_templates --channel conda-forge | ||
``` | ||
|
||
### Documentation | ||
|
||
See the online documentation for much more: [http://docs.udst.org/projects/urbansim-templates](http://docs.udst.org/projects/urbansim-templates/en/latest) | ||
|
||
Some additional documentation is available within the repo in `CHANGELOG.md`, `CONTRIBUTING.md`, `/docs/README.md`, and `/tests/README.md`. | ||
|
||
There's discussion of current and planned features in the [Pull requests](https://github.com/UDST/urbansim_templates/pulls?utf8=✓&q=is%3Apr) and [Issues](https://github.com/UDST/urbansim_templates/issues?utf8=✓&q=is%3Aissue), both open and closed. | ||
There's discussion of current and planned features in the [Pull requests](https://github.com/udst/urbansim_templates/pulls?utf8=✓&q=is%3Apr) and [Issues](https://github.com/udst/urbansim_templates/issues?utf8=✓&q=is%3Aissue), both open and closed. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Empty file.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.