Pandas-OpenSCM
Pandas accessors for OpenSCM-related functionality.
Status
- prototype: the project is just starting up and the code is all prototype
Full documentation can be found at: pandas-openscm.readthedocs.io. We recommend reading the docs there because the internal documentation links don't render correctly on GitHub's viewer.
Installation
As an application
If you want to use Pandas-OpenSCM as an application, then we recommend using the 'locked' version of the package. This version pins the version of all dependencies too, which reduces the chance of installation issues because of breaking updates to dependencies.
The locked version of Pandas-OpenSCM can be installed with
=== "mamba"
sh mamba install -c conda-forge pandas-openscm-locked
=== "conda"
sh conda install -c conda-forge pandas-openscm-locked
=== "pip"
sh pip install 'pandas-openscm[locked]'
As a library
If you want to use Pandas-OpenSCM as a library, for example you want to use it as a dependency in another package/application that you're building, then we recommend installing the package with the commands below. This method provides the loosest pins possible of all dependencies. This gives you, the package/application developer, as much freedom as possible to set the versions of different packages. However, the tradeoff with this freedom is that you may install incompatible versions of Pandas-OpenSCM's dependencies (we cannot test all combinations of dependencies, particularly ones which haven't been released yet!). Hence, you may run into installation issues. If you believe these are because of a problem in Pandas-OpenSCM, please raise an issue.
The (non-locked) version of Pandas-OpenSCM can be installed with
=== "mamba"
sh mamba install -c conda-forge pandas-openscm
=== "conda"
sh conda install -c conda-forge pandas-openscm
=== "pip"
sh pip install pandas-openscm
Additional dependencies can be installed using
=== "mamba" If you are installing with mamba, we recommend installing the extras by hand because there is no stable solution yet (see conda issue #7502)
=== "conda" If you are installing with conda, we recommend installing the extras by hand because there is no stable solution yet (see conda issue #7502)
=== "pip" ```sh # To add basic database dependencies pip install 'pandas-openscm[db]'
# To add all database dependencies
pip install 'pandas-openscm[db-full]'
# To add plotting dependencies
pip install 'pandas-openscm[plots]'
# To add progress bar dependencies
pip install 'pandas-openscm[progress]'
# To add all optional dependencies
pip install 'pandas-openscm[full]'
```