xan/python-awips
1
0
Fork 0
mirror of https://github.com/Unidata/python-awips.git synced 2025-02-23 14:57:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #125 from srcarter3/website

Browse source 
Website
This commit is contained in:
srcarter3 2023-12-12 11:57:08 -07:00 • committed by GitHub
commit 5c323631ce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/source/conf.py
View file

@ -58,15 +58,15 @@ master_doc = 'index'
# General information about the project.
project = 'python-awips'
copyright = '2018, Unidata'
author = 'Unidata'
copyright = '2018, NSF Unidata'
author = 'NSF Unidata'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '18.1.8'
version = '20.1'
# The full version, including alpha/beta/rc tags.
# The language for content autogenerated by Sphinx. Refer to documentation

26
docs/source/index.rst
View file

@ -9,8 +9,6 @@ The python-awips package provides a data access framework for requesting meteoro
.. _Jupyter Notebook: http://nbviewer.jupyter.org/github/Unidata/python-awips/tree/master/examples/notebooks
.. important:: There is now a :ref:`Beta Python-AWIPS<Beta Python-AWIPS Install>` available for v20.
Pre-requisite Software
----------------------
@ -52,31 +50,9 @@ Below are instructions on how to install the source code of python-awips, with a
git clone https://github.com/Unidata/python-awips.git
cd python-awips
conda env create -f environment.yml
conda activate python3-awips
conda activate python-awips-v20
jupyter notebook examples
Beta Python-AWIPS Install
-------------------------
The beta version of python-awips (v20) is currently only available as a source code download and installation. The beta version only works with our beta EDEX server (edex-beta.unidata.ucar.edu) and is not backwards compatible with our production (v18) EDEX server.
Similar to the :ref:`Source Code Install <Source Code with Examples Install>` above, these instructions will create a new environment called ``python-awips-beta20`` and launch a browser with our jupyter notebook examples.
When AWIPS v20 becomes production, this version of python-awips will be the default that is on pip and conda, but until then, this is how you can access and use python-awips v20.
::
git clone --single-branch --branch v20 https://github.com/Unidata/python-awips.git
cd python-awips
conda env create -f environment.yml
conda activate python-awips-beta20
pip install .
jupyter notebook examples
If you come across issues/bugs/missing functionality, please report it using `this short form <https://docs.google.com/forms/d/e/1FAIpQLSf6jyZtbh49g-GCBoAQYzTVwAIf_aKz0QOeAr7gDVFhPrjAmw/viewform?usp=sf_link>`_.
Questions -- Contact Us!
------------------------