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

Uploaded Python 3Windows x86-64

polaris_studio-25.3.1.dev150-py3-none-manylinux_2_35_x86_64.whl (41.8 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev150-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 8af1ff7dc192c3e96b012a29faeeb314f7487879b4adfe2377cfb587e8f0fa1e
MD5 0ea9224f26c9db9a705e0ac3ac73ab4d
BLAKE2b-256 3659a873f74a2020937322c4ccd1344bc1e1659234012d7386239ada34174fa7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for polaris_studio-25.3.1.dev150-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 4524d36d9097bdd603238f6c5080237ded4fd32faeeb3639ed6f936764cb3315
MD5 4e32a6b03817d10328642c302f069bc3
BLAKE2b-256 fd528ceb2fa7b86905c5e09842611f4eb25e59816460349dc2a29a9b396a3e04

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