From d219cf1f48cd932fed0bef3d5c3a7e319677928a Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Tue, 12 Dec 2023 11:54:37 -0700 Subject: [PATCH 1/2] Updates docs for v20 release -update version number -remove "beta" install instructions -update envvironment name to match new env --- docs/source/conf.py | 6 +++--- docs/source/index.rst | 24 +----------------------- 2 files changed, 4 insertions(+), 26 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 500f50d..6f0948c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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 diff --git a/docs/source/index.rst b/docs/source/index.rst index 2a0f5d1..859b615 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -52,31 +52,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 ` 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 `_. - Questions -- Contact Us! ------------------------ From 6a6cf13173ec937c3938e6af23d3b78b4f1f4cbc Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Tue, 12 Dec 2023 11:56:13 -0700 Subject: [PATCH 2/2] Remove one more reference of the "beta" from docs --- docs/source/index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 859b615..d1c1837 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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` available for v20. - Pre-requisite Software ----------------------