xan/awips2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #534 from tiffanycmeyer13/docChanges

Browse source 
Update Windows direct install instructions to not require python or a…
This commit is contained in:
srcarter3 2023-04-24 15:15:46 -06:00 • committed by GitHub
commit 41c83248fc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/appendix/common-problems.md
View file

@ -70,7 +70,7 @@ To resolve this issue, either:
or
- Use our [Virtual Machine option](../install/install-cave/#method-1-linux-virtual-machine). This option allows your actual machine to stay in whichever language you choose, while allowing you to run CAVE in an environment set to English. Although we list this installation under the Windows OS, this can also be done on Linux.
- Use our [Virtual Machine option](../install/install-cave/#method-2-linux-virtual-machine). This option allows your actual machine to stay in whichever language you choose, while allowing you to run CAVE in an environment set to English. Although we list this installation under the Windows OS, this can also be done on Linux.
!!! warning "The VM option has one notable drawback at the moment -- it cannot render RGB satellite products."

2
docs/cave/goes-16-17-satellite.md
View file

@ -209,7 +209,7 @@ There currently 10 channel differences that are offered in CAVE:
* Vegetation (0.64 - 0.87 μm)
* Upper Level Info (11.2 - 6.19 μm)
!!! note "The rendering of these products uses the **Jep** package in Python, which has specific [install instructions](http://127.0.0.1:8000/install/install-cave/#method-2-direct-windows-install) for Windows."
!!! note "The rendering of these products uses the **Jep** package in Python, which has specific [install instructions](http://127.0.0.1:8000/install/install-cave/#method-1-direct-windows-install) for Windows."
---

88
docs/install/install-cave.md
View file

@ -60,7 +60,7 @@ To run CAVE either:
- Use the terminal and type the command `cave`
- Find the application in the Linux Desktop menu: Applications > Internet > AWIPS CAVE
Additionally users can choose to run a [virtual machine (VM)](#method-1-linux-virtual-machine) on Linux.
Additionally users can choose to run a [virtual machine (VM)](#method-2-linux-virtual-machine) on Linux.
---
@ -68,17 +68,31 @@ Additionally users can choose to run a [virtual machine (VM)](#method-1-linux-vi
**Latest Version: 18.2.1-6**
For Windows, Unidata offers two installation options: a [**Linux Virtual Machine**](#method-1-linux-virtual-machine), or a [**Direct Windows Installation**](#method-2-direct-windows-install).
For Windows, Unidata offers two installation options: a [**Direct Windows Installation**](#method-1-direct-windows-install), or a [**Linux Virtual Machine**](#method-2-linux-virtual-machine).
!!! note "As of 4/24/2023, the direct install method has been completely simplified! No admin priviledges or extra software needed."
Currently, the [virtual machine (VM)](#method-1-linux-virtual-machine) is the recommended form of install for those who do not have administrative priviledges on the machine, or beginners who want a simpler installation process.
!!! warning "At the moment, the VM option may not render all products in CAVE (ex. RGB composites of satellite imagery)"
The [direct installation method](#method-2-direct-windows-install) is recommended for those who have administrative priviledges and a little bit of experience installing more software.
### Method 1: Direct Windows Install
This method has been simplified to include python and java packaged with CAVE so no other software installation is necessary. CAVE no longer needs changes to any environment variables in order to run.
### Method 1: Linux Virtual Machine
#### Download and Installation Instructions
This method is recommended for beginners, or those with less computer knowledge as it is a very simple installation, however at this time, some CAVE functionality may be missing (ex: rendering RGB satellite images).
1. Download and install: [**awips-cave.msi** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/windows/awips-cave.msi)
- This will install CAVE to the user level in `%HOMEPATH%\AppDir\Roaming\UCAR Unidata\AWIPS CAVE`.
#### Run CAVE
To run CAVE, either:
- Double click on the `CAVE` shortcut on the desktop
- Type "cave" in the start bar and hit enter
### Method 2: Linux Virtual Machine
This is an additional installation method, however at this time, some CAVE functionality may be missing (ex: rendering RGB satellite images).
#### System Requirements
@ -110,68 +124,6 @@ Once inside the VM, to run CAVE either:
- Use the terminal and type the command `cave`
- Find the application in the Linux Desktop menu: Applications > Internet > AWIPS CAVE
### Method 2: Direct Windows Install
This method is recommended for personal use and requires Administrative priviledges. It should enable full CAVE capability, but it is a bit lengthy and might take about 20 minutes or so to complete.
For additional assistance we have created an [**installation video**](https://youtu.be/QAuBSsSp9Ak) that walks through the steps below.
!!! note "It is important to use the exact versions of software that we link to or specify in our instructions. Deviations may cause installation problems or failures."
#### System Requirements
- 64-bit Miniconda3 (Python3.7 - 4.8.2)
- Python3 (comes with Miniconda installation)
- 64-bit Java JDK 1.8 (1.8_181)
- 64-bit Visual C++ Build Tools 2015 and 2019
- Numpy (1.15.1)
- Jep (3.8.2)
- User Variable PATH must have miniconda3 location
- User Variables PYTHONHOME and PYTHONPATH must be defined
- System Variable JAVA_HOME must be defined
#### Download and Installation Instructions
1. Download and install 64-bit [Miniconda Python3.7 version 4.8.2 for Windows](https://repo.anaconda.com/miniconda/Miniconda3-py37_4.8.2-Windows-x86_64.exe)
- **Allow** Miniconda3 to set **PATH** and other environment variables
- **Register** miniconda as the default python
![Miniconda options](../images/minicondaOptions.png)
2. Download and install the 64-bit [Java JDK 1.8_181](https://downloads.unidata.ucar.edu/awips2/current/windows/jdk-8u181-windows-x64.exe) (this is necessary so Jep can install properly).
- Select **Development Tools** as the installation options
- Make note of where it installs on your computer (the default is C:\ProgramFiles\Java\jdk1.8.0_181)
3. Set the environment variables:
- Access the Environment Variables window by typing "env" in the start bar, hitting enter, and clicking on the "Environment Variables..." button at the bottom of the "System Properties" window
- Create the variables in their respective locations using the **New...** buttons
- User Variables: **PYTHONPATH** and **PYTHONHOME**
- System Variable: **JAVA_HOME**
![Env Vars](../images/envVars.png)
!!! warning "If PYTHONHOME is not set, the **gridslice** Python module will not be installed or available"
4. [Download and install 64-bit Microsoft Visual Studio C++ Build Tools](https://my.visualstudio.com/Downloads?q=Build%20Tools%20for%20Visual%20Studio%202019)
- To access the page linked above you will need a Microsoft account
- Download the executable for **Build Tools for Visual Studio 2019 (version 16.9)**
- Allow it to run some pre-installations
- The installer will pop up as shown below. Make sure to select the **C++ build tools** (upper left), and then view the **Installation details** on the right
- Scroll down and check the **MSVC v140 - VS 2015 C++ build tools**
![buildToolsInstall](../images/buildToolsInstall.png)
5. Install dependent Python packages
- Once the installer has finished, close the installer. Another window is present and there is an option to **launch** a command terminal
![launch terminal](../images/buildToolsLaunchTerm.png)
- Click that and run the following:
- `pip install numpy==1.15.1`
- `pip install jep==3.8.2`
!!! note "These must be run as two separate commands, as stated above for all derived parameters to display properly."
6. Download and install: [**awips-cave.msi** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/windows/awips-cave.msi)
- In addition to the application directory, the MSI installer will attempt to copy the [*gridslice*](https://github.com/Unidata/gridslice) shared library to `$PYTHONHOME/Dlls/`. If the `$PYTHONHOME` environmental variable is not defined *gridslice* will not be installed. You can check to see if it was installed in the Dlls directory after you have completed steps 1-3.
!!! note "CAVE will still run without gridslice, but certain bundles which use derived parameters, such as [**isentropic analysis**](../images/screenCapture-2016.04.04.13.41.26-20160404_000000.png), will not load."
#### Run CAVE
To run CAVE, either:
- Type "cave" in the start bar and hit enter
- Find and run CAVE app in the file browser: C:\Program Files\Unidata\AWIPS CAVE\cave.exe
---
## macOS <i class="fa fa-apple"></i>