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

Updates docs for v20 release

Browse source 
-update version number
-remove "beta" install instructions
-update envvironment name to match new env
This commit is contained in:
Shay Carter 2023-12-12 11:54:37 -07:00
parent dfb927c2ee
commit d219cf1f48
2 changed files with 4 additions and 26 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. # General information about the project.
project = 'python-awips' project = 'python-awips'
copyright = '2018, Unidata' copyright = '2018, NSF Unidata'
author = 'Unidata' author = 'NSF Unidata'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '18.1.8' version = '20.1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation

24
docs/source/index.rst
View file

@ -52,32 +52,10 @@ Below are instructions on how to install the source code of python-awips, with a
git clone https://github.com/Unidata/python-awips.git git clone https://github.com/Unidata/python-awips.git
cd python-awips cd python-awips
conda env create -f environment.yml conda env create -f environment.yml
conda activate python3-awips conda activate python-awips-v20
jupyter notebook examples 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! Questions -- Contact Us!
------------------------ ------------------------