cfr


Namecfr JSON
Version 2024.11.11 PyPI version JSON
download
home_pagehttps://github.com/fzhu2e/cfr
Summarycfr: a Python package for Climate Field Reconstruction
upload_time2024-11-11 18:38:02
maintainerNone
docs_urlNone
authorFeng Zhu, Julien Emile-Geay
requires_pythonNone
licenseBSD 3-Clause
keywords climate field reconstruction
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://badge.fury.io/py/cfr.svg)](https://badge.fury.io/py/cfr)
[![PyPI](https://img.shields.io/badge/python-3.11-blue.svg)]()
[![license](https://img.shields.io/github/license/fzhu2e/cfr.svg)]()
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7855587.svg)](https://doi.org/10.5281/zenodo.7855587)

# `cfr`: a Python package for Climate Field Reconstruction

> [!NOTE]
> If you use `cfr` in any way for your publications, please cite:
> 
> + Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409–3431. https://doi.org/10.5194/gmd-17-3409-2024
> + Zhu, F., Emile-Geay, J., Anchukaitis, K.J., McKay, N.P., Stevenson, S., Meng, Z., 2023. A pseudoproxy emulation of the PAGES 2k database using a hierarchy of proxy system models. Sci Data 10, 624. https://doi.org/10.1038/s41597-023-02489-1

`cfr` aims to provide a universal framework for climate field reconstruction (CFR).
It provides a toolkit for

+ the processing and visualization of the proxy records, climate model simulations, and instrumental observations,
+ the calibration and running of the proxy system models (PSMs, [Evans et al., 2013](https://doi.org/10.1016/j.quascirev.2013.05.024)),
+ the preparation and running of the multiple reconstruction frameworks/algorithms, such as LMR ([Hakim et al., 2016](https://doi.org/10.1002/2016JD024751); [Tardif et al., 2019](https://doi.org/https://doi.org/10.5194/cp-15-1251-2019)) and GraphEM ([Guillot et al., 2015](https://doi.org/10.1214/14-AOAS794)), and
+ the validation of the reconstructions, etc.

For more details, please refer to the documentation linked below.

## Documentation

+ Homepage: https://fzhu2e.github.io/cfr
+ Installation: https://fzhu2e.github.io/cfr/ug-installation.html

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/fzhu2e/cfr",
    "name": "cfr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "climate field reconstruction",
    "author": "Feng Zhu, Julien Emile-Geay",
    "author_email": "fengzhu@ucar.edu, julieneg@usc.edu",
    "download_url": "https://files.pythonhosted.org/packages/a3/1f/82d3f399ecc7d4cc22ed683e319d98a5fbb2dccf22a546795562b7efe296/cfr-2024.11.11.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/cfr.svg)](https://badge.fury.io/py/cfr)\n[![PyPI](https://img.shields.io/badge/python-3.11-blue.svg)]()\n[![license](https://img.shields.io/github/license/fzhu2e/cfr.svg)]()\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7855587.svg)](https://doi.org/10.5281/zenodo.7855587)\n\n# `cfr`: a Python package for Climate Field Reconstruction\n\n> [!NOTE]\n> If you use `cfr` in any way for your publications, please cite:\n> \n> + Zhu, F., Emile-Geay, J., Hakim, G. J., Guillot, D., Khider, D., Tardif, R., & Perkins, W. A. (2024). cfr (v2024.1.26): a Python package for climate field reconstruction. Geoscientific Model Development, 17(8), 3409\u20133431. https://doi.org/10.5194/gmd-17-3409-2024\n> + Zhu, F., Emile-Geay, J., Anchukaitis, K.J., McKay, N.P., Stevenson, S., Meng, Z., 2023. A pseudoproxy emulation of the PAGES 2k database using a hierarchy of proxy system models. Sci Data 10, 624. https://doi.org/10.1038/s41597-023-02489-1\n\n`cfr` aims to provide a universal framework for climate field reconstruction (CFR).\nIt provides a toolkit for\n\n+ the processing and visualization of the proxy records, climate model simulations, and instrumental observations,\n+ the calibration and running of the proxy system models (PSMs, [Evans et al., 2013](https://doi.org/10.1016/j.quascirev.2013.05.024)),\n+ the preparation and running of the multiple reconstruction frameworks/algorithms, such as LMR ([Hakim et al., 2016](https://doi.org/10.1002/2016JD024751); [Tardif et al., 2019](https://doi.org/https://doi.org/10.5194/cp-15-1251-2019)) and GraphEM ([Guillot et al., 2015](https://doi.org/10.1214/14-AOAS794)), and\n+ the validation of the reconstructions, etc.\n\nFor more details, please refer to the documentation linked below.\n\n## Documentation\n\n+ Homepage: https://fzhu2e.github.io/cfr\n+ Installation: https://fzhu2e.github.io/cfr/ug-installation.html\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause",
    "summary": "cfr: a Python package for Climate Field Reconstruction",
    "version": "2024.11.11",
    "project_urls": {
        "Homepage": "https://github.com/fzhu2e/cfr"
    },
    "split_keywords": [
        "climate",
        "field",
        "reconstruction"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a31f82d3f399ecc7d4cc22ed683e319d98a5fbb2dccf22a546795562b7efe296",
                "md5": "125fa8a99b6d12d251912c28a8c24a4d",
                "sha256": "b3ebeb816154b96b03f693bd5620a79853aa8a0a3dd6d7c2c02d074c914f845a"
            },
            "downloads": -1,
            "filename": "cfr-2024.11.11.tar.gz",
            "has_sig": false,
            "md5_digest": "125fa8a99b6d12d251912c28a8c24a4d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 94120,
            "upload_time": "2024-11-11T18:38:02",
            "upload_time_iso_8601": "2024-11-11T18:38:02.344483Z",
            "url": "https://files.pythonhosted.org/packages/a3/1f/82d3f399ecc7d4cc22ed683e319d98a5fbb2dccf22a546795562b7efe296/cfr-2024.11.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-11 18:38:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "fzhu2e",
    "github_project": "cfr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "cfr"
}
        
Elapsed time: 0.87633s