Update README.rst

- removed references of "master" branch and replaced with main
- updated the documentation link to our current website
- added the conda install command for the package install as an alternative to pip
- removed the requirements and examples sections
This commit is contained in:
srcarter3 2021-03-23 08:57:01 -07:00 committed by GitHub
parent fc6f47e6ba
commit 6f1f8a2b0c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -21,7 +21,7 @@ AWIPS Python Data Access Framework
: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
.. |Travis| image:: https://travis-ci.org/Unidata/python-awips.svg?branch=main
:target: https://travis-ci.org/Unidata/python-awips
:alt: Travis Build Status
@ -33,8 +33,8 @@ AWIPS Python Data Access Framework
: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)
.. |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
@ -67,6 +67,10 @@ Install
- pip install python-awips
or
- conda install -c conda-forge python-awips
Conda Environment
-----------------
@ -77,51 +81,13 @@ Conda Environment
- 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
* http://unidata.github.io/python-awips/
* http://nbviewer.jupyter.org/github/Unidata/python-awips/tree/main/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/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_2.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
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Profiler_Wind_Barb_Time-Series_1_0.png
:target: https://python-awips.readthedocs.io/en/latest/examples/generated/Profiler_Wind_Barb_Time-Series.html
:height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Regional_Surface_Obs_Plot_14_0.png
:target: https://python-awips.readthedocs.io/en/latest/examples/generated/Regional_Surface_Obs_Plot.html
:height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/GOES_Geostationary_Lightning_Mapper_3_1.png
:target: https://python-awips.readthedocs.io/en/latest/examples/generated/GOES_Geostationary_Lightning_Mapper.html
:height: 192px
.. image:: https://python-awips.readthedocs.io/en/latest/_images/Colored_Surface_Temperature_Plot_2_1.png
:target: https://python-awips.readthedocs.io/en/latest/examples/generated/Colored_Surface_Temperature_Plot.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
License
-------