Pathways Ensemble Analysis
Overview and scope
The pathways-ensemble-analysis (short: pea) package allows you to perform multi-criteria evaluation style analyses of pathway ensembles produced by energy and climate models.
It has a range of functionality, including the ability to:
- Evaluate user-defined criteria for an ensemble of pathways - for example the share of renewables in 2050.
- Filter the ensemble on the basis of the defined criteria to identify a subset of pathways which is of particular interest - for example based on maximum sustainable levels of carbon dioxide removal.
- Rank pathways on the basis of these criteria by performing a multi-criteria evaluation of the ensemble.
- Visualise the evaluated and ranked criteria of the ensemble.
What's Here
In this repo, there are the following folders and sets of files:
-
src/pathways-ensemble-analysis: contains the source code for the pea package. The definitions of the evaluation criteria are located in thecriteriafolder, with thebasemodule providing more basic, general criteria, and thelibrarymodule providing more specific, pre-defined criteria, as for example the average level of CCS/CDR deployment, biomass consumption, and the probability of overshooting 1.5°C. -
tests: contains the unit testing scripts for the package, which can be run withpytest. -
notebooks: contains an example notebook which shows how the pea package can be used to filter, rank and visualise a diverse set of pathways.
Getting started
-
Clone this repository to your local machine.
-
Create an environment
peawith the help of conda, by runningconda env create -f environment.yml -
Activate this environment via
conda activate pea
Example
An example for how to use this package is given in the notebooks folder here.
Contributors
- Lara Welder (@l-welder) lara.welder@climateanalytics.org
- Neil Grant (@neilgrant) neil.grant@climateanalytics.org
- Jonas Hörsch (@coroa) jonas.hoersch@climateanalytics.org
- Tina Aboumahboub (@Tinaab) tina.aboumahboub@climateanalytics.org
License
Copyright (C) 2022 Climate Analytics. All versions released under the MIT License.
Repository Organization
├── CONTRIBUTORS.md <- List of developers and maintainers.
├── CHANGELOG.md <- Changelog to keep track of new features and fixes.
├── LICENSE.txt <- License as chosen on the command-line.
├── README.md <- README file for the repository
├── environment.yml <- The conda environment file for reproducibility.
├── notebooks <- Jupyter notebooks.
├── setup.cfg <- Declarative configuration of your project.
├── setup.py <- Use `pip install -e .` to install.
├── src
│ └── pathways_ensemble_analysis <- Actual Python package where the main functionality goes.
├── tests <- Unit tests which can be run with `pytest`.
├── .coveragerc <- Configuration for coverage reports of unit tests.
├── .gitignore <- Lists folders and files not tracked by git
├── .isort.cfg <- Configuration for git hook that sorts imports.
└── .pre-commit-config.yaml <- Configuration of pre-commit git hooks.
Metadata
Release files for pathways-ensemble-analysis 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pathways_ensemble_analysis-1.0.0.tar.gz | 2.0 MB | Without provenance | Details for pathways_ensemble_analysis-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pathways_ensemble_analysis-1.0.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for pathways_ensemble_analysis-1.0.0-py2.py3-none-any.whl |
Total release size: 2.0 MB
Release files / pathways_ensemble_analysis-1.0.0.tar.gz
| Download URL | pathways_ensemble_analysis-1.0.0.tar.gz |
|---|---|
| Size | 2.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9dff4c181240c0896495509915065baae023bfb271e85c3dd992199da3cf8e0c
|
|
BLAKE2b-256 checksum How to use checksums |
f44426624a0d1a8b204195caf98c4919868527d49be611ea5a6a2bd8bb965a6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.12
|
Release files / pathways_ensemble_analysis-1.0.0-py2.py3-none-any.whl
| Download URL | pathways_ensemble_analysis-1.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 17.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a985702387b15cb0fe84876f0e56a23d6877d64f380a705d46bb288779d504aa
|
|
BLAKE2b-256 checksum How to use checksums |
d52f7dbc52b4902ea883d34d75fce54254f6d467b0a2782bdefd0ccfd3949dd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.7.12
|
Security for pathways-ensemble-analysis 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.