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

Uploaded Python 3Windows x86-64

polaris_studio-25.3.1.dev87-py3-none-manylinux_2_35_x86_64.whl (40.9 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev87-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7652bf745c51f54d17914b56deddbb22c045b5c30f4486317b73d5014c00455d
MD5 ca07304f0c0dcd0479e465ae02301bf3
BLAKE2b-256 302faf9fa507511effd21cba55b9d00ed82bfb3690cac589a32674667c3bda2a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev87-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 ef28b2cb075432ce14efca6e537fb8dfeeea40e1a19d8e405496f42e1558338f
MD5 0677d56880606f1b4f7c7f5d53601ab1
BLAKE2b-256 1bb1aa7fa6cb17c9983471b4864b8781af2aa854632e2cc3800afc3a8a97f0e3

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