Metadata-Version: 2.1
Name: dparcel
Version: 0.1
Summary: A simple parcel theory model of downdrafts in atmospheric convection.
Home-page: https://github.com/climate-enigma/dparcel
Author: Thomas Schanzer
Author-email: t.schanzer@student.unsw.edu.au
License: BSD 3-Clause License
Project-URL: Documentation, https://dparcel.readthedocs.io/
Project-URL: Source Code, https://github.com/climate-enigma/dparcel
Project-URL: Bug Tracker, https://github.com/climate-enigma/dparcel/issues
Project-URL: Release Notes, https://github.com/climate-enigma/dparcel/releases
Keywords: parcel downdraft atmosphere convection model
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Description-Content-Type: text/x-rst
License-File: LICENSE

dparcel
*********
.. image:: https://github.com/climate-enigma/dparcel/actions/workflows/python-package.yml/badge.svg
    :target: https://github.com/climate-enigma/dparcel/actions/workflows/python-package.yml
    :alt: Test Status
.. image:: https://codecov.io/gh/climate-enigma/dparcel/branch/main/graph/badge.svg?token=HNHGRDKPT8
    :target: https://codecov.io/gh/climate-enigma/dparcel
    :alt: Coverage
.. image:: https://readthedocs.org/projects/dparcel/badge/?version=latest
    :target: https://dparcel.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status
.. image:: https://img.shields.io/github/license/climate-enigma/dparcel
    :target: https://github.com/climate-enigma/dparcel/blob/main/LICENSE
    :alt: License

|

:code:`dparcel` is a very simple model of downdrafts in atmospheric convection that uses parcel theory to simulate the motion of a descending, entraining air parcel.
You may supply any atmospheric sounding and initial conditions for the calculation.

It was developed by Thomas Schanzer, an undergraduate student at the University of New South Wales, as part of a research project under the supervision
of Prof. Steven Sherwood of the UNSW Climate Change Research Centre.

Installation
--------------

Use the package manager `pip <https://pip.pypa.io/en/stable/>`_ to install :code:`dparcel`.

.. code-block:: console

    pip install dparcel

Dependencies
--------------
The following packages must be installed:

* :code:`numpy`
* :code:`scipy`
* :code:`metpy>=1.2`

Documentation
---------------
Documentation is available at https://dparcel.readthedocs.io/.

License
---------
`BSD-3-Clause License <https://github.com/climate-enigma/dparcel/blob/main/LICENSE>`_


