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

Uploaded Python 3Windows x86-64

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev94-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c2d10da1ccfcdfbeb63fd703f660f56019b2261f4e328781ac18b8c6f6e1fa30
MD5 58a006de9b589095792d570d28f393b0
BLAKE2b-256 5096a6a1cab317a998d04af46be5195f7bd51fb1c6aee6b5dcc48a3dcae93dd6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev94-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 2f96c4ada94169a2d9e60a552bcc9bd3bef87a061a0b2bdc0697fed74bcbc30f
MD5 316987df28e615dedce98b7434594013
BLAKE2b-256 4ecb81cc3421f50c39836ec088856aceb6879fb9809c4ddc808c7ab7a1993883

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