{ "info": { "author": "Sylvia Dee, Amir Allam, and Feng Zhu", "author_email": "", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6" ], "description": "[![PyPI](https://img.shields.io/pypi/v/prysm-api.svg)]()\n[![](https://img.shields.io/badge/platform-Mac_Linux-red.svg)]()\n[![](https://img.shields.io/badge/language-Python3-success.svg)](https://www.python.org/)\n![GitHub](https://img.shields.io/github/license/fzhu2e/prysm-api.svg?color=blue)\n[![DOI](https://zenodo.org/badge/180254702.svg)](https://zenodo.org/badge/latestdoi/180254702)\n\n\n# prysm-api\nThe API for [PRoxY System Modeling (PRYSM)](https://github.com/sylvia-dee/PRYSM).\nCurrently, it supports PSMs listed below:\n\n+ Ice-core d18O\n+ Tree-ring width with [VSLite](https://github.com/suztolwinskiward/VSLiteR)\n+ Tree-ring cellulose\n+ Tree MXD\n+ Coral d18O and Sr/Ca\n+ Speleothem d18O\n+ Varve thickness\n\n## How to install\n\nSimply\n```bash\npip install prysm-api LMRt # LMRt provides many useful functions necessary for prysm-api\n```\n\nTo use VS-Lite, in `R`\n```bash\ninstall.packages(\"devtools\")\ndevtools::install_github(\"fzhu2e/VSLiteR\")\n```\n\n\n## Usage examples\n\n+ Calling VS-Lite\n\n```python\nimport prysm\n\nres = prysm.forward(\n 'prysm.vslite', # psm name\n lat_obs, lon_obs, # lat/lon of the target location\n lat, lon, time, # dimension variables of the environmentals\n { # environmental variables:\n 'tas': tas, # surface air temperature in (time, lat, lon) [K]\n 'pr': pr, # precipitation rate in (time, lat, lon) [kg/m2/s]\n },\n T1=8, T2=23, M1=0.01, M2=0.05, # PSM specific parameters\n)\n```\nHere `res` is a dictionary that includes the pseudoproxy values and the\ncorresponding timepoints, plus other output for diagnostics.\n\n+ Calling the PSM for ice core d18O\n\n```python\nimport prysm\n\nres = prysm.forward(\n 'prysm.ice.d18O', # psm name\n lat_obs, lon_obs, # lat/lon of the target location\n lat, lon, time, # dimension variables of the environmentals\n { # environmental variables:\n 'tas': tas, # surface air temperature in (time, lat, lon) [K]\n 'pr': pr, # precipitation rate in (time, lat, lon) [kg/m2/s]\n 'psl': psl, # sea-level pressure in (time, lat, lon) [Pa]\n 'd18Opr': d18Opr, # precipitation d18O in (time, lat, lon) [permil]\n },\n)\n```\n\n## References\n\n+ Dee, S., J. Emile-Geay, M. N. Evans, A. Allam, E. J. Steig, and D. m. Thompson, 2015: PRYSM: An open-source framework for PRoxY System Modeling, with applications to oxygen-isotope systems. J. Adv. Model. Earth Syst., 7, 1220\u20131247, doi:10.1002/2015MS000447.\n+ Dee, S. G., N. J. Steiger, J. Emile-Geay, and G. J. Hakim, 2016: On the utility of proxy system models for estimating climate states over the common era. J. Adv. Model. Earth Syst., 8, 1164\u20131179, doi:10.1002/2016MS000677.\n+ Dee, S. G., L. A. Parsons, G. R. Loope, J. T. Overpeck, T. R. Ault, and J. Emile-Geay, 2017: Improved spectral comparisons of paleoclimate models and observations via proxy system modeling: Implications for multi-decadal variability. Earth and Planetary Science Letters, 476, 34\u201346, doi:10.1016/j.epsl.2017.07.036.\n+ Dee, S. G., J. M. Russell, C. Morrill, Z. Chen, and A. Neary, 2018: PRYSM v2.0: A Proxy System Model for Lacustrine Archives. Paleoceanography and Paleoclimatology, 33, 1250\u20131269, doi:10.1029/2018PA003413.\n\n\n## License\n\nMIT License (see the details [here](LICENSE))\n\n## How to cite\nIf you find this package useful and use it in your research, please cite it with DOI:\n[![DOI](https://zenodo.org/badge/180254702.svg)](https://zenodo.org/badge/latestdoi/180254702)\n\n... and welcome to Star and Fork!", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/fzhu2e/prysm-api", "keywords": "prysm-api", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "prysm-api", "package_url": "https://pypi.org/project/prysm-api/", "platform": "", "project_url": "https://pypi.org/project/prysm-api/", "project_urls": { "Homepage": "https://github.com/fzhu2e/prysm-api" }, "release_url": "https://pypi.org/project/prysm-api/0.5.1/", "requires_dist": null, "requires_python": "", "summary": "The API for PRoxY System Modeling (PRYSM)", "version": "0.5.1" }, "last_serial": 5886927, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "e80234258e2bdb1373828a8b1f91feec", "sha256": "91c4a111f8e55c1ace4aec1563d46925afa0fcce3cfed664012ffb4e211ac802" }, "downloads": -1, "filename": "prysm-api-0.0.1.tar.gz", "has_sig": false, "md5_digest": "e80234258e2bdb1373828a8b1f91feec", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 17005, "upload_time": "2019-04-09T00:51:00", "url": "https://files.pythonhosted.org/packages/7f/7b/226eb02b792fffbff184d6683c07f27ed7e37435d255530883694d6ff896/prysm-api-0.0.1.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "759008bd5d0413274a01967c80653e7a", "sha256": "06e225c2bd9bca004594108e5e33de85ab0917ecd355580bc8e9bd0e445aeac5" }, "downloads": -1, "filename": "prysm-api-0.5.0.tar.gz", "has_sig": false, "md5_digest": "759008bd5d0413274a01967c80653e7a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 21719, "upload_time": "2019-06-27T04:46:38", "url": "https://files.pythonhosted.org/packages/91/b9/66693150d972ef263f689010d7f1f841e75bbf3b60dbf89ab96fa08319c1/prysm-api-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "3329d741b4735e52f8b1d74308311749", "sha256": "21b360633a864e98f27d5f2bfdb5be8176afc64ad5fbb85e56a079315b9b143d" }, "downloads": -1, "filename": "prysm-api-0.5.1.tar.gz", "has_sig": false, "md5_digest": "3329d741b4735e52f8b1d74308311749", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22078, "upload_time": "2019-09-25T19:25:39", "url": "https://files.pythonhosted.org/packages/c9/05/dcfbd126bc95043df63922133b50a6d2ae24b1751a61e1818060ee139b5d/prysm-api-0.5.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3329d741b4735e52f8b1d74308311749", "sha256": "21b360633a864e98f27d5f2bfdb5be8176afc64ad5fbb85e56a079315b9b143d" }, "downloads": -1, "filename": "prysm-api-0.5.1.tar.gz", "has_sig": false, "md5_digest": "3329d741b4735e52f8b1d74308311749", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22078, "upload_time": "2019-09-25T19:25:39", "url": "https://files.pythonhosted.org/packages/c9/05/dcfbd126bc95043df63922133b50a6d2ae24b1751a61e1818060ee139b5d/prysm-api-0.5.1.tar.gz" } ] }