python-awips/README.rst
ucar-tmeyer dfc47202af Update README.rst
When trying to run the release.yml I was getting an error

Checking dist/python_awips-23.1.tar.gz: FAILED
ERROR    `long_description` has syntax errors in markup and would not be
         rendered on PyPI.
         line 63: Warning: Title underline too short.

         Micromamba (or Conda) Environment
         -----------------

So I had to edit the README.rst to add more dashes:

         Micromamba (or Conda) Environment
         ---------------------------------
2025-02-13 11:55:12 -07:00

83 lines
3 KiB
ReStructuredText

AWIPS Python Data Access Framework
==================================
|License| |PyPI| |Conda| |CondaDownloads| |circleci| |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: https://unidata.github.io/python-awips/index.htm
:alt: Latest Doc Build Status
.. |Scrutinizer| image:: https://scrutinizer-ci.com/g/Unidata/python-awips/badges/quality-score.png?b=main
:target: https://scrutinizer-ci.com/g/Unidata/python-awips/?branch=main)
: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://github.com/Unidata/python-awips
:alt: PRs Welcome
.. |circleci|
image:: https://img.shields.io/circleci/project/github/conda-forge/python-awips-feedstock/master.svg?label=noarch
:target: https://circleci.com/gh/conda-forge/python-awips-feedstock
:alt: circleci
.. |CondaDownloads|
image:: https://img.shields.io/conda/dn/conda-forge/python-awips.svg
:target: https://anaconda.org/conda-forge/python-awips
:alt: Conda Downloads
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
or
- micromamba install -c conda-forge python-awips
Micromamba (or Conda) Environment
---------------------------------
- git clone https://github.com/Unidata/python-awips.git
- cd python-awips
- micromamba env create -f environment.yml
- micromamba activate python-awips
- pip install .
- jupyter notebook examples
Documentation
-------------
* http://unidata.github.io/python-awips/
* http://nbviewer.jupyter.org/github/Unidata/python-awips/tree/main/examples/notebooks
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.