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

Uploaded Python 3Windows x86-64

polaris_studio-24.3.323-py3-none-manylinux_2_35_x86_64.whl (82.2 MB view details)

Uploaded Python 3manylinux: glibc 2.35+ x86-64

File details

Details for the file polaris_studio-24.3.323-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for polaris_studio-24.3.323-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 bcd4f4aaf94fa49a8eb2874d0d57eb5fa8cec78d27eb3b92ff15dbe67eb6dc52
MD5 b9304747a3349c66ef8d4327ad4cffcc
BLAKE2b-256 d09dcaa3d10b4d1dd80c348edbaa7c0df2a72163dc7339050954a0bf04ce35ae

See more details on using hashes here.

File details

Details for the file polaris_studio-24.3.323-py3-none-manylinux_2_35_x86_64.whl.

File metadata

File hashes

Hashes for polaris_studio-24.3.323-py3-none-manylinux_2_35_x86_64.whl
Algorithm Hash digest
SHA256 f46932fd98a5cad9a85c74bd5ebe4588f7124194eddee639f160d2a29ac4a963
MD5 a26637952c88da19beb26a365e04a71b
BLAKE2b-256 bd52c55ba8b11ae7306990c84aeec0e02cd16798b8078a0bbc8d60f95e47628d

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