From 97d1d72a7a6b5313d53f991b59210d5b05ef309a Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Thu, 18 Mar 2021 14:39:46 -0700 Subject: [PATCH 1/6] Small change to one of the notebooks to remove the mention of the "DAF" from the markdown text --- examples/notebooks/Grid_Levels_and_Parameters.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/notebooks/Grid_Levels_and_Parameters.ipynb b/examples/notebooks/Grid_Levels_and_Parameters.ipynb index 78262f2..a4a4535 100644 --- a/examples/notebooks/Grid_Levels_and_Parameters.ipynb +++ b/examples/notebooks/Grid_Levels_and_Parameters.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "This example covers the callable methods of the Python AWIPS DAF when working with gridded data. We start with a connection to an EDEX server, then query data types, then grid names, parameters, levels, and other information. Finally the gridded data is plotted for its domain using Matplotlib and Cartopy." + "This example covers the callable methods of python-awips when working with gridded data. We start with a connection to an EDEX server, then query data types, then grid names, parameters, levels, and other information. Finally the gridded data is plotted for its domain using Matplotlib and Cartopy." ] }, { From 5f405731010e717c9a8ac9f6136e060cd86b5b7b Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Thu, 18 Mar 2021 14:46:12 -0700 Subject: [PATCH 2/6] Small change to github action for my srcarter repo. I want the website rebuild to trigger from any branch, because I want to preview web changes here before pushing them to the unidata branch --- .github/workflows/sphinx_build_deploy.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index fe90b22..a62510a 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -2,8 +2,6 @@ name: Publish Sphinx Built Webpages to Github Pages on: push: - branches: - - master paths: - 'docs/**' - 'examples/**' From 93c47beac767e64093277ed5ef9e5141650afa38 Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Thu, 18 Mar 2021 15:10:20 -0700 Subject: [PATCH 3/6] Small change to the index.rst: -modified the wording from "geometry" to "geographic" -this is also a test to see if the website will build as a preview from my fork --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 616f53e..36a47c5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,7 +2,7 @@ Python AWIPS Data Access Framework ================================== -The python-awips package provides a data access framework for requesting meteorological and geometry datasets from an `EDEX `_ server. +The python-awips package provides a data access framework for requesting meteorological and geographic datasets from an `EDEX `_ server. `AWIPS `_ is a weather display and analysis package developed by the National Weather Service for operational forecasting. UCAR's `Unidata Program Center `_ supports a non-operational open-source release of the AWIPS software (`EDEX `_, `CAVE `_, and `python-awips `_). From 1c542df215214a98067be6acf0123bb0c26e71c3 Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Fri, 19 Mar 2021 15:20:08 -0700 Subject: [PATCH 4/6] Changes to the python-awips main webpage: -changed the opening text slightly from "geometry" to "geographic" -added a prerequisite software section that specifies python3, conda, and git (optional) -added a package-only installation section with subsections for pip and conda -moved previous instructions to their own section titled Source Code with Examples Install -removed all remaining information as it was basically a duplicate of what exists on this webpage -added a contact us section with our support email --- docs/source/index.rst | 150 ++++++++++-------------------------------- 1 file changed, 33 insertions(+), 117 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 36a47c5..845efc3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,18 +8,42 @@ 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 + +Pre-requisite Software +---------------------- + +In order to effictively use python-awips you'll need to have these installed already: + - python3 + - conda + - git *(for the source code and examples installation)* + +Package-Only Install +-------------------- + +If you already work with Python, you might just be interested in how to install the python-awips pacakge. +The package can be installed with either of the two well known package managers: **pip** and **conda**. + Pip Install ------------ +~~~~~~~~~~~ :: pip install python-awips -Conda Environment Install -------------------------- +Conda Install +~~~~~~~~~~~~~ -To install the latest version of python-awips, with all required and optional packages: +:: + + conda install -c conda-forge python-awips + + + +Source Code with Examples Install +--------------------------------- + +Below are instructions on how to install the source code of python-awips, with all included example notebooks. This will create a new conda environment called ``python3-awips`` and start up a browser for the jupyter notebook examples. :: @@ -33,117 +57,9 @@ To install the latest version of python-awips, with all required and optional pa **If you are experiencing issues, and have previously setup the conda environment, you may need to run:** :: conda update --all + + +Questions -- Contact Us! +------------------------ - -Requirements ------------- - -These are specified in the environment.yml file that is used to create the 'python3-awips' conda environment: - - - python 3 - - numpy - - nomkl - - matplotlib - - cartopy - - jupyter - - netcdf4 - - owslib - - metpy - - pint - - h5py - - nbconvert 4.1+ - - siphon - - xarray - - ffmpeg - - pytest - - shapely - - six - - pip - - -Quick Example -~~~~~~~~~~~~~ - -:: - - from awips.dataaccess import DataAccessLayer - DataAccessLayer.changeEDEXHost("edex-cloud.unidata.ucar.edu") - dataTypes = DataAccessLayer.getSupportedDatatypes() - list(dataTypes) - - ['acars', - 'binlightning', - 'bufrmosavn', - 'bufrmoseta', - 'bufrmosgfs', - 'bufrmoshpc', - 'bufrmoslamp', - 'bufrmosmrf', - 'bufrua', - 'climate', - 'common_obs_spatial', - 'gfe', - 'gfeeditarea', - 'grid', - 'maps', - 'modelsounding', - 'obs', - 'practicewarning', - 'profiler', - 'radar', - 'radar_spatial', - 'satellite', - 'sfcobs', - 'topo', - 'warning'] - - - request = DataAccessLayer.newDataRequest() - request.setDatatype("satellite") - availableSectors = DataAccessLayer.getAvailableLocationNames(request) - availableSectors.sort() - for sector in availableSectors: - print sector - request.setLocationNames(sector) - availableProducts = DataAccessLayer.getAvailableParameters(request) - availableProducts.sort() - for product in availableProducts: - print " - " + product - - ECONUS - - ACTP - - ADP - - AOD - - CAPE - - CH-01-0.47um - - CH-02-0.64um - - CH-03-0.87um - - CH-04-1.38um - ... - EFD - - ACTP - - ADP - - AOD - - CAPE - - CH-01-0.47um - - CH-02-0.64um - - CH-03-0.87um - - CH-04-1.38um - ... - - -See the `API Documentation `_ for more information. - ----------------------- -Read The Docs Contents ----------------------- - -.. toctree:: - :maxdepth: 2 - - api/index - datatypes - examples/index - dev - gridparms - about +Please feel free to reach out to us at our support email at **support-awips@unidata.ucar.edu** From ad5e63c1d3483ec51f6e96171cce268f11c965b0 Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Mon, 22 Mar 2021 13:56:56 -0700 Subject: [PATCH 5/6] Add 'toctree' back into the index.rst file: -without this command the outline on the left hand does not get generated -also had to add the ':hidden:' flag, so it's not displayed on the body of the page as well --- docs/source/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index 845efc3..98ad9ee 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -63,3 +63,14 @@ Questions -- Contact Us! ------------------------ Please feel free to reach out to us at our support email at **support-awips@unidata.ucar.edu** + +.. toctree:: + :maxdepth: 2 + :hidden: + + api/index + datatypes + examples/index + dev + gridparms + about From ba86d8f70b35eaf555d2f3d136265643409095eb Mon Sep 17 00:00:00 2001 From: Shay Carter Date: Mon, 22 Mar 2021 14:08:32 -0700 Subject: [PATCH 6/6] Update github workflow: -added back in the branch requirement for building the website and switched it from "master" to "main" since we renamed that branch --- .github/workflows/sphinx_build_deploy.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/sphinx_build_deploy.yml b/.github/workflows/sphinx_build_deploy.yml index a62510a..e786273 100644 --- a/.github/workflows/sphinx_build_deploy.yml +++ b/.github/workflows/sphinx_build_deploy.yml @@ -2,6 +2,8 @@ name: Publish Sphinx Built Webpages to Github Pages on: push: + branches: + - main paths: - 'docs/**' - 'examples/**'