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.1.29-py3-none-win_amd64.whl (51.0 MB view details)

Uploaded Python 3Windows x86-64

polaris_studio-25.1.29-py3-none-manylinux_2_35_x86_64.whl (82.0 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

File details

Details for the file polaris_studio-25.1.29-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for polaris_studio-25.1.29-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 34f7a004b3663b2dd57f3c04c9b7d49c09180220ff9183dd1712b07e2c5bccda
MD5 e2043dfc5c24cc5b3f8285ab12c18cc2
BLAKE2b-256 717ebddcffb4864dada3f6a6bee8a39aaf852ee6ecb676ba72b1eedf94f0a174

See more details on using hashes here.

File details

Details for the file polaris_studio-25.1.29-py3-none-manylinux_2_35_x86_64.whl.

File metadata

File hashes

Hashes for polaris_studio-25.1.29-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 d5003d81ec324453ca153500e1e4e2f11b2947dd74eb929bd588f6000a848dd2
MD5 ff3c42f5ffd28cf7156212ea5d6c98da
BLAKE2b-256 662d0c555b9519ce858ca44fa0c20afd8fa824a1db676c472682cdf6e0985c94

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