atmos-python / atmos

An atmospheric sciences library for Python
MIT License
64 stars 21 forks source link

atmos



An atmospheric sciences utility library

atmos is a library of Python programming utilities for the atmospheric sciences. It is in ongoing development. If you have an idea for a feature or have found a bug, please post it on the GitHub issue tracker_.

Information on how to use the module can be found predominantly by using the built-in help() function in Python. Many docstrings are automatically generated by the module and so information may appear to be missing in the source code. There is also HTML documentation_ available.

This module is currently alpha. The API of components at the base module level should stay backwards-compatible, but sub-modules are subject to change. In particular, features in the util module are likely to be changed or removed entirely.

.. contents:: :backlinks: none :depth: 1

Features

Dependencies

This module is tested to work with Python versions 2.6, 2.7, 3.3, and 3.4 on Unix. Support is given for all platforms. If there are bugs on your particular version of Python, please submit it to the GitHub issue tracker_.

Package dependencies:

Installation

To install this module, download and run the following:

.. code:: bash

$ python setup.py install

If you would like to edit and develop the code, you can instead install in develop mode

.. code:: bash

$ python setup.py develop

If you are running Anaconda, you can install using conda:

.. code:: bash

$ conda install -c mcgibbon atmos

You can also install using pip:

.. code:: bash

$ pip install atmos

Development version

The most recent development version can be found in the GitHub develop branch_.

Examples

Calculating pressure from virtual temperature and air density:

.. code:: python

>>> import atmos
>>> atmos.calculate('p', Tv=273., rho=1.27)
    99519.638400000011

License

This module is available under an MIT license. Please see LICENSE.txt.

.. GitHub issue tracker: https://github.com/mcgibbon/atmos/issues .. GitHub develop branch: https://github.com/mcgibbon/atmos/tree/develop .. _HTML documentation: https://pythonhosted.org/atmos