python-awips/README.rst

AWIPS Python Data Access Framework
==================================

|License| |PyPI| |Conda| |Travis| |LatestDocs|

|Codacy| |Scrutinizer| |CodeClimate| |PRWelcome|

.. |License| image:: https://img.shields.io/pypi/l/python-awips.svg
    :target: https://pypi.python.org/pypi/python-awips/
    :alt: License

.. |PyPI| image:: https://img.shields.io/pypi/v/python-awips.svg
        :target: https://pypi.python.org/pypi/python-awips/
        :alt: PyPI Package

.. |PyPIDownloads| image:: https://img.shields.io/pypi/dm/python-awips.svg
        :target: https://pypi.python.org/pypi/python-awips/
        :alt: PyPI Downloads

.. |LatestDocs| image:: https://readthedocs.org/projects/pip/badge/?version=latest
        :target: http://python-awips.readthedocs.org/en/latest/
        :alt: Latest Doc Build Status

.. |Travis| image:: https://travis-ci.org/Unidata/python-awips.svg?branch=master
        :target: https://travis-ci.org/Unidata/python-awips
        :alt: Travis Build Status

.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/560b27db294449ed9484da1aadeaee91
        :target: https://www.codacy.com/app/mjames/python-awips
        :alt: Codacy issues

.. |CodeClimate| image:: https://codeclimate.com/github/Unidata/python-awips/badges/gpa.svg
    :target: https://codeclimate.com/github/Unidata/python-awips
    :alt: Code Climate

.. |Scrutinizer| image:: https://scrutinizer-ci.com/g/Unidata/python-awips/badges/quality-score.png?b=master
    :target: https://scrutinizer-ci.com/g/Unidata/python-awips/?branch=master)
    :alt: Scrutinizer Code Quality

.. |Conda| image:: https://anaconda.org/conda-forge/python-awips/badges/version.svg
    :target: https://anaconda.org/conda-forge/python-awips
    :alt: Conda Package

.. |PRWelcome|
    image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=round-square
    :target: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
    :alt: PRs Welcome

About
-----

The python-awips package provides a data access framework for requesting grid and geometry datasets from an AWIPS `EDEX <http://unidata.github.io/awips2/#edex>`_ server. AWIPS and python-awips packages are released and maintained by UCAR's `Unidata Program Center <http://www.unidata.ucar.edu/software/awips2/>`_ in Boulder, Colorado.

Install
-------

- pip install python-awips

Conda Environment
-----------------

- git clone https://github.com/Unidata/python-awips.git
- cd python-awips
- conda env create -f environment.yml
- source activate python-awips
- python setup.py install --force
- jupyter notebook examples

Requirements
------------

- python >= 2.7
- numpy
- six
- shapely


Documentation
-------------

* http://python-awips.readthedocs.org/en/latest/
* http://nbviewer.jupyter.org/github/Unidata/python-awips/tree/master/examples/notebooks

Examples
--------

.. image:: https://python-awips.readthedocs.io/en/latest/_images/AWIPS_Grids_and_Cartopy_3_0.png
   :target: https://python-awips.readthedocs.io/en/latest/examples/generated/Grid_Levels_and_Parameters.html
   :height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Map_Resources_and_Topography_17_1.png
   :target: https://python-awips.readthedocs.io/en/latest/examples/generated/Map_Resources_and_Topography.html
   :height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/NEXRAD_Level_3_Plot_with_Matplotlib_3_0.png
   :target: https://python-awips.readthedocs.io/en/latest/examples/generated/NEXRAD_Level_3_Plot_with_Matplotlib.html
   :height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Upper_Air_BUFR_Soundings_1_0.png
   :target: https://python-awips.readthedocs.io/en/latest/examples/generated/Upper_Air_BUFR_Soundings.html
   :height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Satellite_Imagery_7_3.png
   :target: https://python-awips.readthedocs.io/en/latest/examples/generated/Satellite_Imagery.html
   :height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Watch_and_Warning_Polygons_5_0.png
   :target: https://python-awips.readthedocs.io/en/latest/examples/generated/Watch_and_Warning_Polygons.html
   :height: 192px

License
-------

Unidata AWIPS source code and binaries (RPMs) are considered to be in the public domain, meaning there are no restrictions on any download, modification, or distribution in any form (original or modified). The Python AWIPS package contains no proprietery content and is therefore not subject to export controls as stated in the Master Rights licensing file and source code headers.