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

Uploaded Python 3Windows x86-64

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev108-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 95c85aab8f1196faea6f755dab0d7f248a9b5d1e9e4682a00e6dd90ea49d16a4
MD5 4f4f0ff7cb47e1bcccfa4923c18e88bc
BLAKE2b-256 912265038d255c81b5956af1127d18bf7f23c39b083a0cb6811a6763aa892d89

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev108-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 1b706d56d882a049d0d07d31ba0fcc09e2a307288fc4d203f623a1808e44b2a3
MD5 d65604cd9e544755723256158ae9f1c6
BLAKE2b-256 cd55447f3600e0577da6bf64ec97fab5e9d54d66946d2cc28933e1bfaad1cd10

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