Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PyPI version PyPI license DOI NSF-1541029

Downloads Downloads Downloads

Python Package for the Analysis of Paleoclimate Data

Paleoclimate data, whether from observations or model simulations, offer unique challenges to the analyst, as they usually come in the form of timeseries with missing values and age uncertainties, which trip up off-the-shelf methods. Pyleoclim is a Python package primarily geared towards the analysis and visualization of such timeseries. The package includes several low-level methods to deal with these issues under the hood, leaving paleoscientists to interact with intuitive, high-level analysis and plotting methods that support publication-quality scientific workflows.

There are many entry points to Pyleoclim, thanks to its underlying data structures. Low-level modules work on NumPy arrays or Pandas dataframes.

We've worked hard to make Pyleoclim accessible to a wide variety of users, from establisher researchers to high-school students, and from seasoned Pythonistas to first-time programmers. A progressive introduction to the package is available at PyleoTutorials. Examples of scientific use are given this paper. A growing collection of research-grade workflows using Pyleoclim and the LinkedEarth research ecosystem are available as Jupyter notebooks on paleoBooks, with video tutorials on the LinkedEarth YouTube channel. Pyleoclim is part of the broader Python ecosystem of Computational Tools for Climate Science. Python novices are encouraged to follow these self-paced tutorials before trying Pyleoclim.

Science-based training materials are also available from the paleoHackathon repository. We also run live training workshops every so often. Follow us on Twitter, or join our Discourse Forum for more information.

Versions

See our releases page for details on what's included in each version.

Documentation

Online documentation is available through readthedocs.

Dependencies

pyleoclim supports Python 3.11 and 3.12 but has only been tested with 3.12 recently.

Installation

The latest stable release is available through Pypi. We recommend using Anaconda or Miniconda with a dedicated environment. Full installation instructions are available in the package documentation

Citation

If you use our code in any way, please consider adding this citation to your publications:

  • Khider, D., Emile-Geay, J., Zhu, F., James, A., Landers, J., Ratnakar, V., & Gil, Y. (2022). Pyleoclim: Paleoclimate timeseries analysis and visualization with Python. Paleoceanography and Paleoclimatology, 37, e2022PA004509. https://doi.org/10.1029/2022PA004509

To cite the current version of the software, please use the citation.cff file. To cite older version of the software, please refer to the Zenodo releases.

Development

Pyleoclim development takes place on GitHub: https://github.com/LinkedEarth/Pyleoclim_util

Please submit any reproducible bugs you encounter to the issue tracker. For usage questions, please use Discourse.

License

The project is licensed under the GNU Public License. Please refer to the file call license. If you use the code in publications, please credit the work using the citation file.

Disclaimer

This material is based upon work supported by the National Science Foundation under Grant Number ICER-1541029. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the investigators and do not necessarily reflect the views of the National Science Foundation.

This research is funded in part by JP Morgan Chase & Co. Any views or opinions expressed herein are solely those of the authors listed, and may differ from the views and opinions expressed by JP Morgan Chase & Co. or its affiliates. This material is not a product of the Research Department of J.P. Morgan Securities LLC. This material should not be construed as an individual recommendation of for any particular client and is not intended as a recommendation of particular securities, financial instruments or strategies for a particular client. This material does not constitute a solicitation or offer in any jurisdiction.

Metadata

Release files for pyleoclim 1.3.1b0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyleoclim 1.3.1b0
File Size Uploaded Provenance Actions
pyleoclim-1.3.1b0.tar.gz 646.9 kB Without provenance Details for pyleoclim-1.3.1b0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyleoclim 1.3.1b0
File Interpreter ABI Platform Actions
pyleoclim-1.3.1b0-py3-none-any.whl Python 3 none any Details for pyleoclim-1.3.1b0-py3-none-any.whl

Total release size: 1.3 MB

Release files / pyleoclim-1.3.1b0.tar.gz

Download URL pyleoclim-1.3.1b0.tar.gz
Size 646.9 kB
Tags Source
SHA-256 checksum
How to use checksums
bb0ff2c542556a8d8ca69b452c9d32fa2f93c5a9d73dd97215ee9e171e31b784
BLAKE2b-256 checksum
How to use checksums
8476bc8798ed9bf8f3083d46ffb8e424306c5fbfc45b2646546e440ded4842fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / pyleoclim-1.3.1b0-py3-none-any.whl

Download URL pyleoclim-1.3.1b0-py3-none-any.whl
Size 678.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3b1380e7ddeb154aef64d54336e43d414fa889eabc04e39945dd17edcef51eb6
BLAKE2b-256 checksum
How to use checksums
16d0a7178cfc52b8199750c9cfb5e89eede5a19bdabfad9fe04d28dc557b91c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Security for pyleoclim 1.3.1b0

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.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page