Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.68 KB

README.md

File metadata and controls

79 lines (55 loc) · 2.68 KB
Raw

RSM

Rapid Strategic Model for the San Diego Association of Governments

Source Code Access

The source code for the RSM is stored in this repository. You can access it via GitHub, or check out the repository using Git. Some larger files (especially for testing) are stored using git-lfs (large file storage). This is mostly transparent, but for best results you do need to make sure that the LFS extension is installed before you clone the repository. Visit git-lfs for platform-specific instructions.

Installing

To install, activate the python or conda environment you want to use, the cd into the repository directory and run:

python -m pip install -e .

This will make the sandag_rsm package available, so you can import sandag_rsm to access the functions in this tool, without regard for the current working directory or pointing the python path to the right place(s). Using the -e flag installs in editable mode, so if you make changes or pull updates from GitHub, those updates will be available to Python without re-installing.

Code Formatting

This repo use several tools to ensure a consistent code format throughout the project:

  • Black for standardized code formatting,
  • Flake8 for general code quality,
  • isort for standardized order in imports, and
  • nbstripout to ensure notebooks are committed to the GitHub repository without bulky outputs included.

We highly recommend that you setup pre-commit hooks to automatically run all the above tools every time you make a git commit. This can be done by running:

pre-commit install

from the root of the repository. You can skip the pre-commit checks with git commit --no-verify.

Developing with Docker

This project uses Docker. For development, to build the docker container, change into the repository root and run:

docker build --tag sandag_rsm .

Jupyter Notebook for Development

On the host machine, on linux or macOS run:

docker run -v $(pwd):/home/mambauser/sandag_rsm -p 8899:8899 \
  -it --rm sandag_rsm jupyter notebook --ip 0.0.0.0 --no-browser --allow-root \
  --port 8899 --notebook-dir=/home/mambauser

or in cwd on Windows, run:

docker run -v %cd%:/home/mambauser/sandag_rsm -p 8899:8899 ^
  -it --rm sandag_rsm jupyter notebook --ip 0.0.0.0 --no-browser --allow-root ^
  --port 8899 --notebook-dir=/home/mambauser

Then visit http://127.0.0.1:8899/tree in your browser.