Skip to main content

Transportation System Simulation Tool

Project description

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

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

polaris_studio-25.3.1.dev136-py3-none-win_amd64.whl (57.1 MB view details)

Uploaded Python 3Windows x86-64

polaris_studio-25.3.1.dev136-py3-none-manylinux_2_35_x86_64.whl (41.5 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

File details

Details for the file polaris_studio-25.3.1.dev136-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev136-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7520ca08eb59b96d5fecbb19b92f22329674be895e786f052e2de1bf92b9e815
MD5 ece565bc4ce5020999b5c810870fa1dd
BLAKE2b-256 5c1d1e719620cbac8f119d1e84e8a667d6f4c24d7aa5fae61e3561b04356cf91

See more details on using hashes here.

File details

Details for the file polaris_studio-25.3.1.dev136-py3-none-manylinux_2_35_x86_64.whl.

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev136-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 f156605e378dbe41538c97a129ad02c989bc16a7fbbc8f3387dcae89f16f3069
MD5 941a16f7c6da7dbd89115bef3749383d
BLAKE2b-256 9fc5c8edc0e1a8e8ef4c346ffdcc755f563b05b9bd6c028179efc14509c6734e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page