| Name | pandas-openscm JSON |
| Version |
0.8.3
JSON |
| download |
| home_page | None |
| Summary | Pandas accessors for OpenSCM-related functionality. |
| upload_time | 2025-08-09 18:12:47 |
| maintainer | None |
| docs_url | None |
| author | Zebedee Nicholls |
| requires_python | >=3.9 |
| license | 3-Clause BSD License |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!--- --8<-- [start:description] -->
# Pandas-OpenSCM
Pandas accessors for OpenSCM-related functionality.
**Key info :**
[](https://pandas-openscm.readthedocs.io)
[](https://github.com/openscm/pandas-openscm/blob/main/pyproject.toml)
[](https://github.com/openscm/pandas-openscm/blob/main/LICENCE)
**PyPI :**
[](https://pypi.org/project/pandas-openscm/)
[](https://github.com/openscm/pandas-openscm/actions/workflows/install-pypi.yaml)
**Conda :**
[](https://anaconda.org/conda-forge/pandas-openscm)
[](https://anaconda.org/conda-forge/pandas-openscm)
[](https://github.com/openscm/pandas-openscm/actions/workflows/install-conda.yaml)
**Tests :**
[](https://github.com/openscm/pandas-openscm/actions/workflows/ci.yaml)
[](https://codecov.io/gh/openscm/pandas-openscm)
**Other info :**
[](https://github.com/openscm/pandas-openscm/commits/main)
[](https://github.com/openscm/pandas-openscm/graphs/contributors)
## Status
<!---
We recommend having a status line in your repo
to tell anyone who stumbles on your repository where you're up to.
Some suggested options:
- prototype: the project is just starting up and the code is all prototype
- development: the project is actively being worked on
- finished: the project has achieved what it wanted
and is no longer being worked on, we won't reply to any issues
- dormant: the project is no longer worked on
but we might come back to it,
if you have questions, feel free to raise an issue
- abandoned: this project is no longer worked on
and we won't reply to any issues
-->
- prototype: the project is just starting up and the code is all prototype
<!--- --8<-- [end:description] -->
Full documentation can be found at:
[pandas-openscm.readthedocs.io](https://pandas-openscm.readthedocs.io/en/latest/).
We recommend reading the docs there because the internal documentation links
don't render correctly on GitHub's viewer.
## Installation
<!--- --8<-- [start: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](https://github.com/openscm/pandas-openscm/issues).
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](https://github.com/conda/conda/issues/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](https://github.com/conda/conda/issues/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]'
```
### For developers
For development, we rely on [uv](https://docs.astral.sh/uv/)
for all our dependency management.
To get started, you will need to make sure that uv is installed
([instructions here](https://docs.astral.sh/uv/getting-started/installation/)
(we found that the self-managed install was best,
particularly for upgrading uv later).
For all of our work, we use our `Makefile`.
You can read the instructions out and run the commands by hand if you wish,
but we generally discourage this because it can be error prone.
In order to create your environment, run `make virtual-environment`.
If there are any issues, the messages from the `Makefile` should guide you through.
If not, please raise an issue in the
[issue tracker](https://github.com/openscm/pandas-openscm/issues).
For the rest of our developer docs, please see [development][development].
<!--- --8<-- [end:installation] -->
## Original template
This project was generated from this template:
[copier core python repository](https://gitlab.com/openscm/copier-core-python-repository).
[copier](https://copier.readthedocs.io/en/stable/) is used to manage and
distribute this template.
Raw data
{
"_id": null,
"home_page": null,
"name": "pandas-openscm",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Zebedee Nicholls",
"author_email": "Zebedee Nicholls <zebedee.nicholls@climate-energy-college.org>",
"download_url": "https://files.pythonhosted.org/packages/ec/8e/2eef64c401767bc5db85e59b0e65c2b12ad20596b16812a7417f9b52560d/pandas_openscm-0.8.3.tar.gz",
"platform": null,
"description": "<!--- --8<-- [start:description] -->\n# Pandas-OpenSCM\n\nPandas accessors for OpenSCM-related functionality.\n\n**Key info :**\n[](https://pandas-openscm.readthedocs.io)\n[](https://github.com/openscm/pandas-openscm/blob/main/pyproject.toml)\n[](https://github.com/openscm/pandas-openscm/blob/main/LICENCE)\n\n**PyPI :**\n[](https://pypi.org/project/pandas-openscm/)\n[](https://github.com/openscm/pandas-openscm/actions/workflows/install-pypi.yaml)\n\n**Conda :**\n[](https://anaconda.org/conda-forge/pandas-openscm)\n[](https://anaconda.org/conda-forge/pandas-openscm)\n[](https://github.com/openscm/pandas-openscm/actions/workflows/install-conda.yaml)\n\n**Tests :**\n[](https://github.com/openscm/pandas-openscm/actions/workflows/ci.yaml)\n[](https://codecov.io/gh/openscm/pandas-openscm)\n\n**Other info :**\n[](https://github.com/openscm/pandas-openscm/commits/main)\n[](https://github.com/openscm/pandas-openscm/graphs/contributors)\n## Status\n\n<!---\n\nWe recommend having a status line in your repo\nto tell anyone who stumbles on your repository where you're up to.\nSome suggested options:\n\n- prototype: the project is just starting up and the code is all prototype\n- development: the project is actively being worked on\n- finished: the project has achieved what it wanted\n and is no longer being worked on, we won't reply to any issues\n- dormant: the project is no longer worked on\n but we might come back to it,\n if you have questions, feel free to raise an issue\n- abandoned: this project is no longer worked on\n and we won't reply to any issues\n-->\n\n- prototype: the project is just starting up and the code is all prototype\n\n<!--- --8<-- [end:description] -->\n\nFull documentation can be found at:\n[pandas-openscm.readthedocs.io](https://pandas-openscm.readthedocs.io/en/latest/).\nWe recommend reading the docs there because the internal documentation links\ndon't render correctly on GitHub's viewer.\n\n## Installation\n\n<!--- --8<-- [start:installation] -->\n### As an application\n\nIf you want to use Pandas-OpenSCM as an application,\nthen we recommend using the 'locked' version of the package.\nThis version pins the version of all dependencies too,\nwhich reduces the chance of installation issues\nbecause of breaking updates to dependencies.\n\nThe locked version of Pandas-OpenSCM can be installed with\n\n=== \"mamba\"\n ```sh\n mamba install -c conda-forge pandas-openscm-locked\n ```\n\n=== \"conda\"\n ```sh\n conda install -c conda-forge pandas-openscm-locked\n ```\n\n=== \"pip\"\n ```sh\n pip install 'pandas-openscm[locked]'\n ```\n\n### As a library\n\nIf you want to use Pandas-OpenSCM as a library,\nfor example you want to use it\nas a dependency in another package/application that you're building,\nthen we recommend installing the package with the commands below.\nThis method provides the loosest pins possible of all dependencies.\nThis gives you, the package/application developer,\nas much freedom as possible to set the versions of different packages.\nHowever, the tradeoff with this freedom is that you may install\nincompatible versions of Pandas-OpenSCM's dependencies\n(we cannot test all combinations of dependencies,\nparticularly ones which haven't been released yet!).\nHence, you may run into installation issues.\nIf you believe these are because of a problem in Pandas-OpenSCM,\nplease [raise an issue](https://github.com/openscm/pandas-openscm/issues).\n\nThe (non-locked) version of Pandas-OpenSCM can be installed with\n\n=== \"mamba\"\n ```sh\n mamba install -c conda-forge pandas-openscm\n ```\n\n=== \"conda\"\n ```sh\n conda install -c conda-forge pandas-openscm\n ```\n\n=== \"pip\"\n ```sh\n pip install pandas-openscm\n ```\n\nAdditional dependencies can be installed using\n\n=== \"mamba\"\n If you are installing with mamba, we recommend\n installing the extras by hand because there is no stable\n solution yet (see [conda issue #7502](https://github.com/conda/conda/issues/7502))\n\n=== \"conda\"\n If you are installing with conda, we recommend\n installing the extras by hand because there is no stable\n solution yet (see [conda issue #7502](https://github.com/conda/conda/issues/7502))\n\n=== \"pip\"\n ```sh\n # To add basic database dependencies\n pip install 'pandas-openscm[db]'\n\n # To add all database dependencies\n pip install 'pandas-openscm[db-full]'\n\n # To add plotting dependencies\n pip install 'pandas-openscm[plots]'\n\n # To add progress bar dependencies\n pip install 'pandas-openscm[progress]'\n\n # To add all optional dependencies\n pip install 'pandas-openscm[full]'\n ```\n\n### For developers\n\nFor development, we rely on [uv](https://docs.astral.sh/uv/)\nfor all our dependency management.\nTo get started, you will need to make sure that uv is installed\n([instructions here](https://docs.astral.sh/uv/getting-started/installation/)\n(we found that the self-managed install was best,\nparticularly for upgrading uv later).\n\nFor all of our work, we use our `Makefile`.\nYou can read the instructions out and run the commands by hand if you wish,\nbut we generally discourage this because it can be error prone.\nIn order to create your environment, run `make virtual-environment`.\n\nIf there are any issues, the messages from the `Makefile` should guide you through.\nIf not, please raise an issue in the\n[issue tracker](https://github.com/openscm/pandas-openscm/issues).\n\nFor the rest of our developer docs, please see [development][development].\n\n<!--- --8<-- [end:installation] -->\n\n## Original template\n\nThis project was generated from this template:\n[copier core python repository](https://gitlab.com/openscm/copier-core-python-repository).\n[copier](https://copier.readthedocs.io/en/stable/) is used to manage and\ndistribute this template.\n",
"bugtrack_url": null,
"license": "3-Clause BSD License",
"summary": "Pandas accessors for OpenSCM-related functionality.",
"version": "0.8.3",
"project_urls": {
"Changelog": "https://pandas-openscm.readthedocs.io/en/stable/changelog",
"Documentation": "https://pandas-openscm.readthedocs.io",
"Homepage": "https://pandas-openscm.readthedocs.io",
"Issues": "https://github.com/openscm/pandas-openscm/issues",
"Repository": "https://github.com/openscm/pandas-openscm"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c08743d684c0a3958ec001d4c6646b72985916677a6229fb68fe1a43dcc7d76d",
"md5": "256c92c015996d003d903b6b9148f0fd",
"sha256": "0432d9275ee61ae895d493ee7cc64e9841c3074381158a2834382f9c55359487"
},
"downloads": -1,
"filename": "pandas_openscm-0.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "256c92c015996d003d903b6b9148f0fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 78836,
"upload_time": "2025-08-09T18:12:46",
"upload_time_iso_8601": "2025-08-09T18:12:46.158309Z",
"url": "https://files.pythonhosted.org/packages/c0/87/43d684c0a3958ec001d4c6646b72985916677a6229fb68fe1a43dcc7d76d/pandas_openscm-0.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ec8e2eef64c401767bc5db85e59b0e65c2b12ad20596b16812a7417f9b52560d",
"md5": "bafca9d0a621510c7196570b6e756253",
"sha256": "fdf015906ad2bde4b4db57ff5dd45d5cb694ad9348d54447397fc9e2c2451635"
},
"downloads": -1,
"filename": "pandas_openscm-0.8.3.tar.gz",
"has_sig": false,
"md5_digest": "bafca9d0a621510c7196570b6e756253",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 60628,
"upload_time": "2025-08-09T18:12:47",
"upload_time_iso_8601": "2025-08-09T18:12:47.729447Z",
"url": "https://files.pythonhosted.org/packages/ec/8e/2eef64c401767bc5db85e59b0e65c2b12ad20596b16812a7417f9b52560d/pandas_openscm-0.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-09 18:12:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openscm",
"github_project": "pandas-openscm",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pandas-openscm"
}
