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

Uploaded Python 3Windows x86-64

polaris_studio-25.3.1.dev101-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.dev101-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev101-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 2112b18294cb5766dba5510678ee25347f2d1e0738fbc8d6f37ed45e7fa604c0
MD5 3a869438aa1105ba424c3cd7e83794c7
BLAKE2b-256 e22f5d0152f06fd6c43484b22a7d31ad740cb9a833dd78e4af18c50c0d51f886

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev101-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 3e5626b82a9965ccd246c4e8dc51bd55f6b83412f6cb116a5663ffffbbc29c87
MD5 f9e983e9737247e16261b7235a0d79b1
BLAKE2b-256 9ba98a3566407aab1ee11827906ba387787af14623572ad83a7351c8f6dbecd7

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