| Name | pyrcel JSON |
| Version |
1.3.2
JSON |
| download |
| home_page | |
| Summary | pyrcel: 0D adiabatic cloud parcel model |
| upload_time | 2023-09-26 06:40:29 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) Daniel Rothenberg, 2012-2019 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the {organization} nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
numba
numpy
pandas
pyyaml
scipy
setuptools
xarray
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
pyrcel: cloud parcel model
==========================
[](https://zenodo.org/badge/latestdoi/12927551)[](https://badge.fury.io/py/pyrcel)[](https://circleci.com/gh/darothen/pyrcel/tree/master)[](http://pyrcel.readthedocs.org/en/stable/?badge=stable)
This is an implementation of a simple, adiabatic cloud parcel model for use in
aerosol-cloud interaction studies. [Rothenberg and Wang (2016)](http://journals.ametsoc.org/doi/full/10.1175/JAS-D-15-0223.1) discuss the model in detail and its improvements
and changes over [Nenes et al (2001)][nenes2001]:
* Implementation of κ-Köhler theory for condensation physics ([Petters and
Kreidenweis, 2007)][pk2007]
* Extension of model to handle arbitrary sectional representations of aerosol
populations, based on user-controlled empirical or parameterized size distributions
* Improved, modular numerical framework for integrating the model, including bindings
to several different stiff integrators:
- `lsoda` - [scipy ODEINT wrapper](http://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.odeint.html)
- `vode, lsode*, lsoda*` - ODEPACK via [odespy][hplgit]
- `cvode` - SUNDIALS via [Assimulo](http://www.jmodelica.org/assimulo_home/index.html#)
among other details. It also includes a library of droplet activation routines and scripts/notebooks for evaluating those schemes against equivalent calculations done with the parcel model.
Updated code can be found the project [github repository](https://github.com/darothen/pyrcel). If you'd like to use this code or have any questions about it, please [contact the author][author_email]. In particular, if you use this code for research purposes, be sure to carefully read through the model and ensure that you have tweaked/configured it for your purposes (i.e., modifying the accomodation coefficient); other derived quantities).
[Detailed documentation is available](http://pyrcel.readthedocs.org/en/latest/index.html), including a [scientific description](http://pyrcel.readthedocs.org/en/latest/sci_descr.html), [installation details](http://pyrcel.readthedocs.org/en/latest/install.html), and a [basic example](http://pyrcel.readthedocs.org/en/latest/examples/basic_run.html) which produces a figure like the plot at the top of this page.
Requirements
------------
**Required**
* Python >= 3.7
* [numba](http://numba.pydata.org)
* [NumPy](http://www.numpy.org)
* [SciPy](http://www.scipy.org)
* [pandas](http://pandas.pydata.org) - v0.25+
* [xarray](http://xarray.pydata.org/en/stable/) - v2023+
* [PyYAML](http://pyyaml.org/)
**Optional**
The following packages are used for better numerics (ODE solving)
* [Assimulo](http://www.jmodelica.org/assimulo)
The easiest way to satisfy the basic requirements for building and running the
model is to use the [Anaconda](http://continuum.io/downloads) scientific Python
distribution. Alternatively, a
[miniconda environment](http://conda.pydata.org/docs/using/envs.html) is
provided to quickly set-up and get running the model. Assimulo's dependency on
the SUNDIALS library makes it a little bit tougher to install in an automated
fashion, so it has not been included in the automatic setup provided here; you
should refer to [Assimulo's documentation](http://www.jmodelica.org/assimulo_home/installation.html)
for more information on its installation process. Note that many components of
the model and package can be used without Assimulo.
Development
-----------
[http://github.com/darothen/pyrcel]()
Please fork this repository if you intend to develop the model further so that the
code's provenance can be maintained.
License
-------
[All scientific code should be licensed](http://www.astrobetter.com/the-whys-and-hows-of-licensing-scientific-code/). This code is released under the New BSD (3-clause) [license](LICENSE.md).
[author_email]: mailto:daniel@danielrothenberg.com
[nenes2001]: http://nenes.eas.gatech.edu/Preprints/KinLimitations_TellusPP.pdf
[pk2007]: http://www.atmos-chem-phys.net/7/1961/2007/acp-7-1961-2007.html
[hplgit]: https://github.com/hplgit/odespy
Raw data
{
"_id": null,
"home_page": "",
"name": "pyrcel",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "Daniel Rothenberg <daniel@danielrothenberg.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/43/403f9aff3a12512404c9a90d4ac1a4917eb47ce0438ce6727b9f50225e45/pyrcel-1.3.2.tar.gz",
"platform": null,
"description": "pyrcel: cloud parcel model\n==========================\n\n\n\n[](https://zenodo.org/badge/latestdoi/12927551)[](https://badge.fury.io/py/pyrcel)[](https://circleci.com/gh/darothen/pyrcel/tree/master)[](http://pyrcel.readthedocs.org/en/stable/?badge=stable)\n\n\nThis is an implementation of a simple, adiabatic cloud parcel model for use in\naerosol-cloud interaction studies. [Rothenberg and Wang (2016)](http://journals.ametsoc.org/doi/full/10.1175/JAS-D-15-0223.1) discuss the model in detail and its improvements\n and changes over [Nenes et al (2001)][nenes2001]:\n\n* Implementation of \u03ba-K\u00f6hler theory for condensation physics ([Petters and\nKreidenweis, 2007)][pk2007]\n* Extension of model to handle arbitrary sectional representations of aerosol\npopulations, based on user-controlled empirical or parameterized size distributions\n* Improved, modular numerical framework for integrating the model, including bindings\nto several different stiff integrators:\n - `lsoda` - [scipy ODEINT wrapper](http://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.odeint.html)\n - `vode, lsode*, lsoda*` - ODEPACK via [odespy][hplgit]\n - `cvode` - SUNDIALS via [Assimulo](http://www.jmodelica.org/assimulo_home/index.html#)\n\namong other details. It also includes a library of droplet activation routines and scripts/notebooks for evaluating those schemes against equivalent calculations done with the parcel model.\n\nUpdated code can be found the project [github repository](https://github.com/darothen/pyrcel). If you'd like to use this code or have any questions about it, please [contact the author][author_email]. In particular, if you use this code for research purposes, be sure to carefully read through the model and ensure that you have tweaked/configured it for your purposes (i.e., modifying the accomodation coefficient); other derived quantities).\n\n[Detailed documentation is available](http://pyrcel.readthedocs.org/en/latest/index.html), including a [scientific description](http://pyrcel.readthedocs.org/en/latest/sci_descr.html), [installation details](http://pyrcel.readthedocs.org/en/latest/install.html), and a [basic example](http://pyrcel.readthedocs.org/en/latest/examples/basic_run.html) which produces a figure like the plot at the top of this page.\n\nRequirements\n------------\n\n**Required**\n\n* Python >= 3.7\n* [numba](http://numba.pydata.org)\n* [NumPy](http://www.numpy.org)\n* [SciPy](http://www.scipy.org)\n* [pandas](http://pandas.pydata.org) - v0.25+\n* [xarray](http://xarray.pydata.org/en/stable/) - v2023+\n* [PyYAML](http://pyyaml.org/)\n\n**Optional**\n\nThe following packages are used for better numerics (ODE solving)\n\n* [Assimulo](http://www.jmodelica.org/assimulo)\n\nThe easiest way to satisfy the basic requirements for building and running the\nmodel is to use the [Anaconda](http://continuum.io/downloads) scientific Python\ndistribution. Alternatively, a\n[miniconda environment](http://conda.pydata.org/docs/using/envs.html) is\nprovided to quickly set-up and get running the model. Assimulo's dependency on\nthe SUNDIALS library makes it a little bit tougher to install in an automated\nfashion, so it has not been included in the automatic setup provided here; you\nshould refer to [Assimulo's documentation](http://www.jmodelica.org/assimulo_home/installation.html)\nfor more information on its installation process. Note that many components of\nthe model and package can be used without Assimulo.\n\nDevelopment\n-----------\n\n[http://github.com/darothen/pyrcel]()\n\nPlease fork this repository if you intend to develop the model further so that the\ncode's provenance can be maintained.\n\nLicense\n-------\n\n[All scientific code should be licensed](http://www.astrobetter.com/the-whys-and-hows-of-licensing-scientific-code/). This code is released under the New BSD (3-clause) [license](LICENSE.md).\n\n[author_email]: mailto:daniel@danielrothenberg.com\n[nenes2001]: http://nenes.eas.gatech.edu/Preprints/KinLimitations_TellusPP.pdf\n[pk2007]: http://www.atmos-chem-phys.net/7/1961/2007/acp-7-1961-2007.html\n[hplgit]: https://github.com/hplgit/odespy\n",
"bugtrack_url": null,
"license": "Copyright (c) Daniel Rothenberg, 2012-2019 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the {organization} nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "pyrcel: 0D adiabatic cloud parcel model",
"version": "1.3.2",
"project_urls": {
"Documentation": "https://pyrcel.readthedocs.io/en/latest/",
"Repository": "https://github.com/darothen/pyrcel"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "724c191b9d9c5a8f8a59392b4440e7e18817d4d7125dc0857678475e9a32c209",
"md5": "caebeb10aa2b5c6939ba485db22e343c",
"sha256": "53615980e2bd9bfc5b9cc1fddd0c04999595cab22f510ff78f92b3807ec73934"
},
"downloads": -1,
"filename": "pyrcel-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "caebeb10aa2b5c6939ba485db22e343c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 140648,
"upload_time": "2023-09-26T06:40:27",
"upload_time_iso_8601": "2023-09-26T06:40:27.061319Z",
"url": "https://files.pythonhosted.org/packages/72/4c/191b9d9c5a8f8a59392b4440e7e18817d4d7125dc0857678475e9a32c209/pyrcel-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa43403f9aff3a12512404c9a90d4ac1a4917eb47ce0438ce6727b9f50225e45",
"md5": "f14d95209dd996f3e3cf5ca6777de198",
"sha256": "0fcf7c5d3c90595a6607bc2e2d865097e5a54de683d4654fbd438d855402da8d"
},
"downloads": -1,
"filename": "pyrcel-1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "f14d95209dd996f3e3cf5ca6777de198",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 610554,
"upload_time": "2023-09-26T06:40:29",
"upload_time_iso_8601": "2023-09-26T06:40:29.097027Z",
"url": "https://files.pythonhosted.org/packages/fa/43/403f9aff3a12512404c9a90d4ac1a4917eb47ce0438ce6727b9f50225e45/pyrcel-1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 06:40:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "darothen",
"github_project": "pyrcel",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [
{
"name": "numba",
"specs": []
},
{
"name": "numpy",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "scipy",
"specs": []
},
{
"name": "setuptools",
"specs": []
},
{
"name": "xarray",
"specs": []
}
],
"lcname": "pyrcel"
}
