From 9dd591a7cdf123ad4b14f62af279d9ab3e7337f1 Mon Sep 17 00:00:00 2001 From: Michael James Date: Wed, 19 Sep 2018 22:03:11 -0600 Subject: [PATCH] docs: install, index, config file updates --- docs/cave/d2d-grids.md | 36 +++---- docs/dev/build-nsharp-macos.md | 181 --------------------------------- docs/index.md | 40 +------- docs/install/install-cave.md | 29 ++++-- environment.yml | 1 + mkdocs.yml | 1 - 6 files changed, 43 insertions(+), 245 deletions(-) delete mode 100644 docs/dev/build-nsharp-macos.md diff --git a/docs/cave/d2d-grids.md b/docs/cave/d2d-grids.md index d797cd991a..2dbccba215 100644 --- a/docs/cave/d2d-grids.md +++ b/docs/cave/d2d-grids.md @@ -1,69 +1,69 @@ -# MSLP and Precipitation +## MSLP and Precipitation ![](../images/screenCapture-2016.04.04.13.43.40-20160402_120000.png) -# Sfc Temperature and Wind +## Sfc Temperature and Wind ![](../images/screenCapture-2016.04.04.13.35.35-20160404_000000.png) -# Sfc Dewpoint Temperature +## Sfc Dewpoint Temperature ![](../images/screenCapture-2016.04.04.13.35.51-20160404_000000.png) -# Sfc Relative Humidity +## Sfc Relative Humidity ![](../images/screenCapture-2016.04.04.13.36.06-20160403_150000.png) -# 30mb Mean Dewpoint +## 30mb Mean Dewpoint ![](../images/screenCapture-2016.04.04.13.36.14-20160404_000000.png) -# Precipitable Water +## Precipitable Water ![](../images/screenCapture-2016.04.04.13.36.20-20160404_000000.png) -# Simulated Reflectivity (REFC) +## Simulated Reflectivity (REFC) ![](../images/screenCapture-2016.04.04.13.36.45-20160331_120000.png) -# Lightning Threat +## Lightning Threat -# Precip Type / Moisture Transport +## Precip Type / Moisture Transport ![](../images/screenCapture-2016.04.04.13.36.56-20160404_000000.png) -# Vorticity (500mb) +## Vorticity (500mb) ![](../images/screenCapture-2016.04.04.13.37.03-20160404_000000.png) -# Vertical Velocity (500mb, 700mb, 850mb) +## Vertical Velocity (500mb, 700mb, 850mb) ![](../images/screenCapture-2016.04.04.13.37.10-20160404_000000.png) -# Thickness / Vorticity Advection (Trenberth) +## Thickness / Vorticity Advection (Trenberth) ![](../images/screenCapture-2016.04.04.13.37.27-20160404_000000.png) -# Wind / Height (850mb, 700mb, 500mb, 300mb, 250mb) +## Wind / Height (850mb, 700mb, 500mb, 300mb, 250mb) ![](../images/screenCapture-2016.04.04.13.37.34-20160404_000000.png) -# Potential Vorticity (250mb) +## Potential Vorticity (250mb) -# Helicity / Storm-Relative Flow +## Helicity / Storm-Relative Flow -# Hail Parameters +## Hail Parameters ![](../images/screenCapture-2016.04.04.13.37.56-20160331_150000.png) -# MCS Parameters +## MCS Parameters ![](../images/screenCapture-2016.04.04.13.38.36-20160331_150000.png) -# Isentopic Analysis (270K-320K) +## Isentopic Analysis (270K-320K) ![](../images/screenCapture-2016.04.04.13.41.26-20160404_000000.png) diff --git a/docs/dev/build-nsharp-macos.md b/docs/dev/build-nsharp-macos.md deleted file mode 100644 index 78bcfa3136..0000000000 --- a/docs/dev/build-nsharp-macos.md +++ /dev/null @@ -1,181 +0,0 @@ -A little known fact in the world of AWIPS(II) is just how dependent the system still is on NAWIPS-GEMPAK. The entire National Centers Perspective is dependent on pre-built shared object files for 64-bit Linux, which means that all of the D2D plugins which extend NSHARP (for bufr obs, NPP profiles, forecast models, etc.) also depend on these libraries. - -This dependency has prevented use of the NSHARP plugin in the first release (15.1.1) of the [OS X CAVE client](https://www.unidata.ucar.edu/downloads/awips2/awips2-cave.dmg). These are the steps taken to build NSHARP and GEMPAK libraries for OS X AWIPS 16.2.2. - -You will need the [https://github.com/Unidata/awips2-gemlibs](https://github.com/Unidata/awips2-gemlibs) repository on your Mac, as well as gcc and gfortran (from XCode). Pay attention to any version-specific include path or linked files, such as `/usr/local/Cellar/gcc/4.9.2_1/lib/gcc/4.9/`, always account for the correct versions and locations on your own system. - -## NSHARP pre-built libraries - -> libbignsharp.dylib - -Using the script below, the NSHARP dynamic library is built from C and FORTRAN source files (and their required include files supplied by the `awips2-gemlibs` repository, and as linked against `$GEMINC`, meaning that GEMPAK for OS X must be built and installed). - - git clone https://github.com/Unidata/awips2-gemlibs.git - cd awips2-gemlibs/nsharp/ - -An optional step, which can be performed in a separate script or within the build script below, is to create *ld-style* *.a files in `$OS_LIB` which can then be referenced with `-l` flags (e.g. `-lgemlib`): - - libs=(snlist sflist nxmlib gemlib gplt cgemlib rsl device xwp xw ps gn nsharp netcdf textlib) - for file in ${libs[@]} - do - if [ ! -f $OS_LIB/lib$file.a ]; then - echo "$OS_LIB/lib$file.a does not exist" - if [ -f $OS_LIB/$file.a ]; then - cp $OS_LIB/$file.a $OS_LIB/lib$file.a - echo "copied OS_LIB/$file.a to OS_LIB/lib$file.a for linking" - fi - fi - done - - -Build libbignsharp.dylib with the following script (Note the GEMPAK includes and links `-I$NSHARP`, `-I$GEMPAK/include`, `-L$OS_LIB`, etc.). - - #!/bin/bash - cd ~/awips2-gemlibs/nsharp/ - . $NAWIPS/Gemenviron.profile - CC=gcc - FC=gfortran - - export NSHARP=$GEMPAK/source/programs/gui/nsharp - export NWX=$GEMPAK/source/programs/gui/nwx - - myLibs="$OS_LIB/ginitp_alt.o $OS_LIB/gendp_alt.o" - - myCflags="$CFLAGS -I. -I./Sndglib -I$NSHARP -I$GEMPAK/include -I$OS_INC -I$NWX \ - -I/opt/X11/include/X11 -I/usr/include/Xm -I/opt/local/include -I/usr/include/malloc -Wcomment -Wno-return-type -Wincompatible-pointer-types -DUNDERSCORE -fPIC -DDEBUG -c" - - myFflags="-I. -I$OS_INC -I$GEMPAK/include -I$NSHARP -fPIC -g -c -fno-second-underscore -fmax-errors=200 -std=f95" - - myLinkflags="-L/usr/local/Cellar/gcc/4.9.2_1/lib/gcc/4.9/ -L/opt/local/lib -L$OS_LIB -L. -L./Sndglib -L/usr/X11R6/lib \ - -shared -Wl -Wcomment -Wincompatible-pointer-types -Wimplicit-function-declaration -Wno-return-type,-install_name,libbignsharp.dylib -o libbignsharp.dylib" - - myLibsInc="$OS_LIB/ginitp_alt.o $OS_LIB/gendp_alt.o $OS_LIB/libnxmlib.a $OS_LIB/libsnlist.a \ - $OS_LIB/libsflist.a $OS_LIB/libgemlib.a $OS_LIB/libcgemlib.a $OS_LIB/libgplt.a $OS_LIB/libdevice.a \ - $OS_LIB/libxwp.a $OS_LIB/libxw.a $OS_LIB/libps.a $OS_LIB/libgn.a $OS_LIB/libcgemlib.a $OS_LIB/libgemlib.a \ - $OS_LIB/libnetcdf.a $OS_LIB/libtextlib.a $OS_LIB/libxml2.a $OS_LIB/libxslt.a \ - $OS_LIB/libgemlib.a $OS_LIB/libcgemlib.a $OS_LIB/librsl.a $OS_LIB/libbz2.a" - - myLinktail="-I$OS_INC \ - -I$GEMPAK/include -I$NWX -I$NSHARP -I. -I./Sndglib -I/opt/X11/include/X11 -I/usr/include -I/usr/include/Xm -I/opt/local/include/ -I/opt/local/include -lhdf5 -lgfortran -ljasper -lpng -liconv -lc -lXt -lX11 -lz -lm -lXm" - - $CC $myCflags *.c Sndglib/*.c - $FC $myFflags *.f - $CC $myLinkflags *.o $myLibsInc $myLinktail - - cp libbignsharp.dylib ~/awips2-ncep/viz/gov.noaa.nws.ncep.ui.nsharp.macosx/ - - -## GEMPAK pre-built libraries - -> libgempak.dylib - -libgempak.dylib is built in a similar way as libbignsharp.dylib: - - #!/bin/bash - cd ~/awips2-gemlibs/gempak/ - . $NAWIPS/Gemenviron.profile - CC=gcc - FC=gfortran - - myCflags="$CFLAGS -I. -I$GEMPAK/source/diaglib/dg -I$GEMPAK/source/gemlib/er \ - -I/opt/X11/include/X11 -I/usr/include/Xm -I/opt/local/include -I/usr/include/malloc -fPIC -DDEBUG -c" - - myFflags="-I. -I$OS_INC -I$GEMPAK/include -fPIC -g -c -Wtabs -fno-second-underscore" - - myLinkflags="-L/usr/local/Cellar/gcc/4.9.2_1/lib/gcc/4.9/ -L/opt/local/lib -L$OS_LIB -L. \ - -shared -Wl -Wno-return-type,-install_name,libgempak.dylib -o libgempak.dylib" - - myLibs="$OS_LIB/ginitp_alt.o $OS_LIB/gendp_alt.o $OS_LIB/libcgemlib.a \ - $OS_LIB/libsflist.a $OS_LIB/gdlist.a $OS_LIB/libcgemlib.a $OS_LIB/libgemlib.a \ - $OS_LIB/libcgemlib.a $OS_LIB/libgplt.a $OS_LIB/libdevice.a $OS_LIB/libcgemlib.a \ - $OS_LIB/libgn.a $OS_LIB/libgemlib.a $OS_LIB/libcgemlib.a $OS_LIB/libnetcdf.a \ - $OS_LIB/libcgemlib.a $OS_LIB/libtextlib.a $OS_LIB/libxml2.a $OS_LIB/libxslt.a \ - $OS_LIB/libcgemlib.a $OS_LIB/libgemlib.a $OS_LIB/libcgemlib.a $OS_LIB/libcgemlib.a \ - $OS_LIB/librsl.a $OS_LIB/libcgemlib.a $OS_LIB/libbz2.a" - - myLinktail="-I$OS_INC -I$GEMPAK/include -I. -I/opt/X11/include/X11 -I/usr/include \ - -I/usr/include/Xm -I/opt/local/include/ -I/opt/local/include \ - -lhdf5 -lgfortran -ljasper -lpng -liconv -lc -lXt -lX11 -lz -lm -lXm" - - $CC $myCflags *.c - $FC $myFflags *.f - $CC $myLinkflags *.o $myLibs $myLinktail - - cp libgempak.dylib ~/awips2-ncep/viz/gov.noaa.nws.ncep.viz.gempak.nativelib.macosx/ - - -> libcnflib.dylib - - - #!/bin/bash - cd ~/awips2-gemlibs/cnflib/ - . $NAWIPS/Gemenviron.profile - CC=gcc - FC=gfortran - - myCflags="$CFLAGS -I/opt/X11/include/X11 -I/usr/include/Xm -I/opt/local/include \ - -I/usr/include/malloc -Wno-return-type -DUNDERSCORE -fPIC -DDEBUG -g -c" - - myLinkflags="-L/usr/local/Cellar/gcc/4.9.2_1/lib/gcc/4.9/ -L/opt/local/lib \ - -shared -Wl -Wno-return-type,-install_name,libcnflib.dylib -o libcnflib.dylib" - - myLinktail="-lgfortran -lc" - - myLibs="$OS_LIB/ginitp_alt.o $OS_LIB/gendp_alt.o $OS_LIB/gdlist.a $OS_LIB/gdcfil.a \ - $OS_LIB/libgemlib.a $OS_LIB/libgplt.a $OS_LIB/libdevice.a $OS_LIB/libgn.a \ - $OS_LIB/libcgemlib.a $OS_LIB/libgemlib.a $OS_LIB/libnetcdf.a $OS_LIB/libtextlib.a \ - $OS_LIB/libxslt.a $OS_LIB/libxml2.a -liconv \ - $OS_LIB/libz.a $OS_LIB/librsl.a -lbz2" - - $CC $myCflags *.c - $CC $myLinkflags *.o $myLibs $myLinktail - - cp libcnflib.dylib ~/awips2-ncep/viz/gov.noaa.nws.ncep.viz.gempak.nativelib.macosx/ - - -> libaodtv64.dylib - - #!/bin/bash - CC=gcc - FC=gfortran - - cd ~/awips2-gemlibs/aodt/AODTLIB/ - - gcc -fPIC -g -c -Wall *.c *.h - gcc -shared -Wl,-Wno-return-type,-install_name,libaodtv64.dylib -o libaodtv64.dylib *.o -lc - - cp libaodtv64.dylib ~/awips2-ncep/viz/gov.noaa.nws.ncep.viz.gempak.nativelib.macosx/ - - - -> libg2g.dylib - - #!/bin/bash - cd ~/awips2-gemlibs/g2g/ - . $NAWIPS/Gemenviron.profile - CC=gcc - FC=gfortran - - myCflags="$CFLAGS -I$GEMPAK/include -I. -I$GEMPAK/source/diaglib/dg \ - -I$GEMPAK/source/gemlib/er -I/opt/X11/include/X11 -I/usr/include/Xm \ - -I/opt/local/include -I/usr/include/malloc -Wno-return-type -DUNDERSCORE \ - -fPIC -DDEBUG -c" - - myFflags="-I. -I$OS_INC -I$GEMPAK/include -fPIC -g -c -Wtabs -fno-second-underscore" - - myLinkflags="-L/usr/local/Cellar/gcc/4.9.2_1/lib/gcc/4.9/ -L/opt/local/lib \ - -L/usr/X11R6/lib -shared -Wl -Wno-return-type,-install_name,libg2g.dylib -o libg2g.dylib" - - myLinktail="-lgfortran $OS_LIB/libjasper.a -lpng -lc" - - myLibs="$OS_LIB/ginitp_alt.o $OS_LIB/gendp_alt.o $OS_LIB/gdlist.a \ - $OS_LIB/gdcfil.a $OS_LIB/libgemlib.a $OS_LIB/libgplt.a $OS_LIB/libdevice.a \ - $OS_LIB/libgn.a $OS_LIB/libcgemlib.a $OS_LIB/libgemlib.a $OS_LIB/libnetcdf.a \ - $OS_LIB/libtextlib.a $OS_LIB/libxslt.a $OS_LIB/libxml2.a \ - -liconv $OS_LIB/libz.a $OS_LIB/librsl.a -lbz2" - - $CC $myCflags *.c - $FC $myFflags *.f - $CC $myLinkflags *.o $myLibs $myLinktail - - cp libg2g.dylib ~/awips2-ncep/viz/gov.noaa.nws.ncep.viz.gempak.nativelib.macosx/ diff --git a/docs/index.md b/docs/index.md index dfa5da26e7..18c8af9fae 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,50 +23,21 @@ AWIPS takes a unified approach to data ingest, and most data types follow a path Unidata supports two visualization frameworks for rendering data: [CAVE](install/install-cave), and the Python Data Access Framework ([python-awips](http://python-awips.readthedocs.io)). ---- - -## Download and Install CAVE - -> [Release 18.1.1-1, September 19, 2018](https://www.unidata.ucar.edu/blogs/news/category/AWIPS) - -| | | -|:----------------------------------------:|:--| -|

Linux

|

[install.sh --cave ](https://www.unidata.ucar.edu/software/awips2/install.sh)

For CentOS/Red Hat 6 and 7. Installs to /awips2/cave and writes files to ~/caveData.

chmod 755 install.sh
sudo ./install.sh --cave

Run CAVE from the Linux Desktop menu Applications > Internet > AWIPS CAVE, or from the command line as simply `cave`.

System Requirements

You can reset CAVE at any time by removing the **~/caveData** directory (on macOS **~/Library/caveData**) and reconnecting to an EDEX server.

| - -| | | -|:----------------------------------------:|:--| -|

macOS

|

Download and install both
[awips2-cave-18.1.1-1.dmg ](https://www.unidata.ucar.edu/downloads/awips2/awips2-cave-18.1.1-1.dmg)
[awips-python.pkg ](https://www.unidata.ucar.edu/downloads/awips2/awips-python.pkg)

**Supported Graphics Devices for macOS**

  • Intel HD Graphics
  • Intel Iris
  • NVIDIA GeForce

    • **Unsupported Graphics Devices for macOS**

  • AMD Radeon R9
  • AMD Radeon Pro
  • AMD FirePro D300

    • Writes and syncs files to ~/Library/caveData.

    **awips-python.pkg** is not a prerequisite, and CAVE will still run and display data without it, but to use any derived parameter functions such as wind barbs/arrows and grid parameters on various vertical coordinates, jep must be installed in some way (it is assumed in /Library/Python/2.7/site-packages/jep/)

    | - - -| | | -|:----------------------------------------:|:--| -|

    Windows

    |

    [awips-cave-18.1.1-1.amd64.msi ](https://www.unidata.ucar.edu/downloads/awips2/awips-cave-18.1.1-1.amd64.msi)

    Writes files to **~/caveData** (in your user home directory)

    Requires Python 3, Numpy, and Jep be installed

    Requires **PYTHONHOME** be defined

    - -### Windows-Specific Instructions - -
    -

    1) Download and install Miniconda Python 3.7 for Windows

    2) Install dependent Python packages

    3) Run awips-cave-18.1.1-1.amd64.msi

    -
    - -> [Read full CAVE install instructions](install/install-cave) +![CAVE](https://www.unidata.ucar.edu/software/awips2/images/Unidata_AWIPS2_CAVE.png) --- -## Download and Install EDEX +## [Download and Install CAVE](install/install-cave) -> [Release 18.1.1-1, September 19, 2018](https://www.unidata.ucar.edu/blogs/news/category/AWIPS) +--- -| | | -|:----------------------------------------:|:--| -|

    Linux

    |

    [install.sh --edex ](https://www.unidata.ucar.edu/software/awips2/install.sh)

    Installs to /awips2/ directories.

    chmod 755 install.sh
    sudo ./install.sh --edex

    Start and Stop:

    edex start
    edex stop

    System Requirements