polaris-studio 26.1.17.dev1

Transportation System Simulation Tool

polaris-studio

The polaris-studio package is th Python gateway for all things Polaris. The package is divided in several submodules varying from data preparation to result analysis and is the source of truth for the data model required by Polaris.

For the package's full description and documentation, see: https://polaris.taps.anl.gov/polaris/index.html

For release notes, see: https://polaris.taps.anl.gov/polaris/releases/index.html

The standard installation of Polaris-Studio brings a minimum set of dependencies, which are those required for running a simulation. For a full installation, please install

pip install polaris-studio[builder]

We recommend using virtual environments to prevent dependency clashes. In the root folder of the repo you will find a script called setup_venv.sh (linux) or setup_venv.bat (windows) which will create a virtual environment into a sub-directory venv of the repo and install that as a kernel (named "polaris-studio") which can be used with any jupyter notebooks you are running.

./setup_venv.sh

Documentation

Polaris-studio is also responsible for building the documentation website (https://polaris.taps.anl.gov). The steps for building are outlined in the ci/documentation_ci.yml gitlab CI definition file and require the cloning of the polaris-linux and QPolaris repositories. This can be achieved in a local environment by running

./docs/build_all_locally.sh

There are a number of example notebooks in the documentation that require additional datafiles to run, these can be downloaded and run locally using the following command

./docs/build_consolidated_docs.sh grab
./docs/build_consolidated_docs.sh run_notebooks [optional_pattern]

The optional pattern can be used to only run one notebook if you are adding a new one or debugging one that has developed a problem.