From baa39ae70c68a7b8ad2d8a42e8a497d6eb0384be Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Mon, 18 Sep 2023 14:52:58 -0600 Subject: [PATCH] Updates to website branch for beta install instructions --- docs/source/index.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index 7435fb6f..2a0f5d19 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,8 @@ 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 ---------------------- @@ -54,6 +56,28 @@ Below are instructions on how to install the source code of python-awips, with a 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! ------------------------