CAVE is the **C**ommon **A**WIPS **V**isualization **E**nvironment that is used for rendering and analyzing data for AWIPS. The installer may require administrator priviledges to install and may require other system changes (environment variables, etc) as well.
---
## Latest CAVE Versions
- [**Linux: 20.3.2-0.1**](#linux)
- [**Windows:**](#windows) VM option available, but direct install not yet supported
!!! note "Version 20.* of CAVE is not compatible with Version 18.* EDEX and vice versa, Version 18.* of CAVE is not compatible with Version 20.* EDEX."
---
## General Requirements
Regardless of what Operating System CAVE is running on, these general requirements are recommended in order for CAVE to perform optimally:
- Local machine
!!! error "Running CAVE via X11 forwarding or ssh tunneling is **not** supported. Using a [VNC connection is the only remote option](../appendix/common-problems.md#remotely-connecting-to-cave), and may result in worse performance than running locally."
!!! warning "While other graphics cards *may* work, NVIDIA Quadro graphics card is recommended for full visualization capability"
---
## Linux <i class="fa fa-linux"></i>
**Latest Version: 20.3.2-0.1**
### System Requirements
- 64 bit CentOS/Red Hat 7
- Bash shell environment
!!! note "While CentOS8 has reach End of Life as of Dec. 31, 2021, CentOS7 End of Life isn't until June 30, 2024."
### Download and Installation Instructions
1. Download the following installer: [**awips_install-v20.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/20.3.2/linux/awips_install-v20.sh)
2. In a terminal, go to the download directory
3. Make the installer an executable by running: `chmod 755 awips_install-v20.sh`
4. Run the installer: `sudo ./awips_install-v20.sh --cave`
- This will install the application in `/awips2/cave/` and set the local cache to `~/caveData/`
### Run CAVE
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)](#linux-virtual-machine) on linux.
---
## Windows <i class="fa fa-windows"></i>
**Latest Version: 20.3.2-0.1**
Currently the only installation available for Windows, is the [**Linux Virtual Machine**](#linux-virtual-machine).
### Linux Virtual Machine
Some CAVE functionality may be missing (ex: rendering RGB satellite images).
#### System Requirements
- [VMWare Workstation Player](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html) must be installed (free software):
- For high definition monitors (4k), you will want to enable the high DPI setting for VMWare Workstation Player
1. Create a desktop shortcut for VMWare Workstation Player
1. Right-click the shortcut and select Properties
1. Open the Compatability Tab
1. Select the "Change high DPI settings" button
1. Check the "High DPI scaling ovveride" checkbox and choose "Application" in the enabled dropdown
#### Download and Installation Instructions
1. Download the zipped file containing the virtual machine: [**CentOS7-Unidata-CAVE-20.3.2-0.1** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/20.3.2/windows/CentOS7-Unidata-CAVE-20.3.2-0.1.zip)
2. Unzip the folder.
3. Open VMWare Player and go to **Player** > **File...** > **Open** and locate the folder that was created from the downloaded zipped file. Select the file called **"CentOS 7 - Unidata CAVE 20.3.2-0.1.vmx"**.
4. Run this new VM option. If it asks if it's been moved or copied, select **"I Copied It"**.
- There will be a user in the Linux machine named "awips" and the password is "awips"
- The root password is "unidataAWIPS" if ever needed
#### Run CAVE
Once inside the VM, to run CAVE either:
- Use the desktop icon
- Use the terminal and type the command `cave`
- Find the application in the Linux Desktop menu: Applications > Internet > AWIPS CAVE
---
## EDEX Connection
Unidata and Jetstream2 have partnered to offer a EDEX data server in the cloud, open to the public. Select the server in the Connectivity Preferences dialog, or enter **edex-beta.unidata.ucar.edu**.
---
## Local Cache
After connecting to an EDEX server, you will have a local directory named **caveData** which contains files synced from EDEX as well as a client-side cache for data and map resources.
You can reset CAVE by removing the **caveData** directory and reconnecting to an EDEX server. Your local files have been removed, but if you are re-connecting to an EDEX server you have used before, the remote files will sync again to your local **~/caveData** (bundles, colormaps, etc.).
- Linux: `/home/<user>/caveData/`
- macOS: `/Users/<user>/Library/caveData/`
- Windows: `C:\Users\<user>\caveData\`
---
## Functionality/Reporting
The radar menu has not been updated yet to reflect what is in version 18.*. To report any other bugs/issues/broken functionality, please fill out <ahref=https://forms.gle/aYUZSi78KU3ZYJ3q7>this short form</a>.
These are instructions to manually uninstall CAVE. However, the [`awips_install-v20.sh`](#download-and-installation-instructions) script will do these steps for you if you are installing a newer version of CAVE.
!!! note "If you are having trouble removing a group, see the [troubleshooting](../appendix/common-problems.md#troubleshooting-uninstalling-edex) section."
**3. Check to make sure all awips rpms have been removed**
```
rpm -qa | grep awips2
```
If you still have rpms installed, remove them
```
sudo yum remove awips2-*
```
**4. Remove the cave directory in /awips2 and caveData from your home directory**
