Skip to main content

Python tools for multi-objective decision analysis and visualization

Project description

parasolpy

Python tools for multi-objective decision analysis and visualization, continuing the Parasol project originally published as:

Raseman, W. J., Jacobson, J., & Kasprzyk, J. R. (2019). Parasol: An open source, interactive parallel coordinates library for multi-objective decision making. Environmental Modelling & Software, 116, 153–163. https://doi.org/10.1016/j.envsoft.2019.03.005

Developed by the Kasprzyk Research Group at CU Boulder.

Status

🚧 Active development. APIs are mostly stable but may change between 0.x releases.

Installation

From PyPI:

pip install parasolpy

Requires Python ≥ 3.12.

From source (for development):

Requires Poetry to be installed on your system (e.g. pipx install poetry):

git clone https://github.com/kasprzyk-research/parasolpy.git
cd parasolpy
poetry install

What's inside

parasolpy bundles several modules for reservoir analysis, streamflow synthesis, multi-objective tradeoff exploration, and supporting plotting and file utilities.

Module Purpose
parasolpy.reservoir Sequent-peak reservoir sizing
parasolpy.ism Index-sequential method (ISM) trace ensembles
parasolpy.nowak Nowak et al. (2010) nonparametric streamflow disaggregation
parasolpy.tradeoff Epsilon non-dominance, KMeans labeling, HiPlot parallel coordinates
parasolpy.plotting Heatmap, spaghetti, fan chart, seasonality, exceedance plots
parasolpy.dash_tools Interactive Dash app powering the parasolpy-tradeoff CLI
parasolpy.interactive Terminal prompts for epsilon-experiment workflows
parasolpy.file_processing Borg / RiverWare solution CSV normalization
parasolpy.util Path helpers, unit conversions, XML config parsing

Tradeoff explorer CLI

Once installed, launch an interactive parallel-coordinates explorer against a results folder:

parasolpy-tradeoff path/to/output_folder

Equivalent module invocation (useful during development):

python -m parasolpy.dash_tools path/to/output_folder

Common options:

  • --config FILE — override auto-discovered config XML
  • --solutions FILE — override auto-discovered solutions CSV
  • --title TEXT — heading shown above the plot
  • --colorscale NAME — any Plotly named colorscale (default viridis)
  • --host HOST / --port PORT — bind address (defaults 127.0.0.1:8050)
  • --debug — run Dash in debug mode

Examples

The examples/ directory contains self-contained scripts that generate their own synthetic data — no external files needed. Run any of them from the repo root:

python examples/01_reservoir_sequent_peak.py
python examples/03_tradeoff_parallel_plot.py
# ...etc.

Figures and CSV/HTML outputs land in examples/_output/. See examples/README.md for the full script list.

Lineage and related packages

This package is developed by the Kasprzyk Research Group at CU Boulder. It is not affiliated with the unrelated parasol or pyparasol packages on PyPI, which are independent projects that share the name.

Citation

If you use parasolpy in academic work, please cite the original Parasol paper linked above.

Development

  • Cutting a release? See RELEASING.md for the Poetry-based workflow (version bump, build, publish to PyPI, tag, GitHub Release).
  • Issues and pull requests are welcome on GitHub.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

parasolpy-0.1.1.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

parasolpy-0.1.1-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file parasolpy-0.1.1.tar.gz.

File metadata

  • Download URL: parasolpy-0.1.1.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.10 Windows/11

File hashes

Hashes for parasolpy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d2f3e9b8e1cf3a0f13990e7db452fc938c5ab8c1b2ba3d00be0275ce240aaf15
MD5 089d04e44164a16cbdc9a1ebd82f2321
BLAKE2b-256 842bbbed1a8610572262797e964ac6d55af9645f327a8e37004818b085b7d9be

See more details on using hashes here.

File details

Details for the file parasolpy-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: parasolpy-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.10 Windows/11

File hashes

Hashes for parasolpy-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0ab72c886abb1af98e33e6948b709d0dde0cebd10968b14b6ae93b2db146eb17
MD5 a059b224ad721c7a656af5bb7f08160b
BLAKE2b-256 c17639d55e1420c4cab933702d4184544a327b9d4a53c8a25d3575a4513e270a

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