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

Uploaded Python 3Windows x86-64

polaris_studio-25.3.1.dev129-py3-none-manylinux_2_35_x86_64.whl (41.2 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev129-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 7cf244eb64ceb9d0bb1af09e13f07f6a66e80a3ac67884259f1568b8bd93cf89
MD5 6fc9d12d2b0776ff94f05a66d304cf5b
BLAKE2b-256 940a29650fa190a7dceb7523dd68f9f864c9c1a5af774cc1cf56f5470022cf61

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev129-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 83cff3436392240b398590786ecfb11f3b90ee14857259f5c419528ed8b04b36
MD5 b56fa5d34a286b61567bc76176ca1dfa
BLAKE2b-256 41eaa032155b0df48421a7e79bce4213c19d29955f64ddea589ce22eb1114e47

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