Merge pull request #711 from tiffanycmeyer13/docs
Documentation updates for 23.4.1-0.4 beta release
This commit is contained in:
tiffanycmeyer13
GitHub
commit
b6e0131df3
12 changed files with 173 additions and 132 deletions
|
|
@ -185,6 +185,7 @@ A full list of all released blogs can be found below:
|
|||
- [Upcoming CentOS7 End of Life](https://www.unidata.ucar.edu/blogs/news/entry/awips-tips-upcoming-centos7-end)
|
||||
- [AWIPS 23.4.1-0.2 Beta CAVE Software Release](https://www.unidata.ucar.edu/blogs/news/entry/awips-tips-unidata-awips-23)
|
||||
- [AWIPS 23.4.1-0.3 Full Beta Software Release](https://www.unidata.ucar.edu/blogs/news/entry/awips-tips-awips-full-beta)
|
||||
- [AWIPS 23.4.1-0.4 Full Beta Software Release](https://www.unidata.ucar.edu/blogs/news/entry/awips-tips-awips-full-beta1)
|
||||
|
||||
#### CAVE
|
||||
|
||||
|
|
|
|||
BIN
docs/images/downloadVersion.png
Normal file
BIN
docs/images/downloadVersion.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 76 KiB |
BIN
docs/images/newVM.png
Normal file
BIN
docs/images/newVM.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
BIN
docs/images/register.png
Normal file
BIN
docs/images/register.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
BIN
docs/images/screening.png
Normal file
BIN
docs/images/screening.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 70 KiB |
BIN
docs/images/vmware-update-dpi.png
Executable file
BIN
docs/images/vmware-update-dpi.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
|
|
@ -1,4 +1,4 @@
|
|||
# Install CAVE - <span style="color:red">BETA Version!</span>
|
||||
# Install CAVE (v20 EOL)
|
||||
|
||||
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.
|
||||
|
||||
|
|
@ -6,19 +6,22 @@ CAVE is the **C**ommon **A**WIPS **V**isualization **E**nvironment that is used
|
|||
|
||||
## Latest CAVE Versions
|
||||
|
||||
- [**Linux: 23.4.1-0.3**](#linux)
|
||||
- [**Windows: 23.4.1-0.3**](#windows)
|
||||
- [**Mac: 23.4.1-0.3**](#macos)
|
||||
>Note: Version 20* of CAVE and EDEX runs on CentOS7 which was End of Life (EOL) on Jun 30, 2024. Unidata is still running a public version 20.3.2 EDEX and has CAVE installers available for the time being until we can officially release version 23 in a non-beta form. This will happen once the National Weather Service (NWS) officially releases 23.4.1 to operations.
|
||||
|
||||
- [**Linux: 20.3.2-2**](#linux)
|
||||
- [**Windows: 20.3.2-2**](#windows)
|
||||
- [**Mac: 20.3.2-2**](#macos)
|
||||
- [**BETA Version 23.4.1-0.3**](install-cave.md) (Compatible with RHEL/Rocky8)
|
||||
|
||||
[**View release notes**](https://www.unidata.ucar.edu/blogs/news/tags/awips-release)
|
||||
|
||||
!!! note "Version 23.\* of CAVE is not compatible with Version 20.\* EDEX and vice versa, Version 20.\* of CAVE is not compatible with Version 23.\* EDEX."
|
||||
!!! note "Major versions of CAVE and EDEX are not always cross compatible. Please use the same version CAVE to connect to the same version EDEX to ensure proper functionality."
|
||||
|
||||
---
|
||||
|
||||
## Functionality/Reporting
|
||||
|
||||
This is a beta release, so we are aware that not all functionality is working as expected. We ask you to please be aware of this and have similar expectations. If you come across issues/bugs/missing functionality, we also encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLScqWZho98cI8ByYTe99YRidfiYK_VeHvjsAculZmiVdWGwUnw/viewform?usp=sf_link" target="_blank">report it using this short form</a>.
|
||||
If you come across issues/bugs/missing functionality, we also encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLSehkNYMNb5G-_kfAEWN1sEPfcePawmN4kUp4IyIoWqRXtoZCw/viewform?usp=sf_link" target="_blank">report it using this short form</a>.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -29,7 +32,7 @@ Regardless of what Operating System CAVE is running on, these general requiremen
|
|||
- 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."
|
||||
|
||||
|
||||
- OpenGL 2.0 Compatible Devices
|
||||
- At least 4GB RAM
|
||||
- At least 2GB Disk Space for Caching
|
||||
|
|
@ -42,19 +45,27 @@ Regardless of what Operating System CAVE is running on, these general requiremen
|
|||
|
||||
## Linux <i class="fa fa-linux"></i>
|
||||
|
||||
**Latest Version: 23.4.1-0.3**
|
||||
**Latest Version: 20.3.2-2**
|
||||
|
||||
### System Requirements
|
||||
|
||||
- 64 bit Rocky/Red Hat 8
|
||||
- 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."
|
||||
|
||||
### Upgrade Existing Installation
|
||||
|
||||
Whether you have CAVE currently installed or not, you can follow the [Download and Installation Instructions](#download-and-installation-instructions) below. The script will remove the old version of CAVE if needed, and install the latest version.
|
||||
|
||||
If you would like to completely remove CAVE, please see the [uninstall instructions further down this page](#linux_1).
|
||||
|
||||
### Download and Installation Instructions
|
||||
|
||||
1. Download the following installer: [**awips_install-v23.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/linux/awips_install-v23.sh)
|
||||
1. Download the following installer: [**awips_install.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/linux/awips_install.sh)
|
||||
2. In a terminal, go to the download directory
|
||||
3. Make the installer an executable by running: `chmod 755 awips_install-v23.sh`
|
||||
4. Run the installer: `sudo ./awips_install-v23.sh --cave`
|
||||
3. Make the installer an executable by running: `chmod 755 awips_install.sh`
|
||||
4. Run the installer: `sudo ./awips_install.sh --cave`
|
||||
- This will install the application in `/awips2/cave/` and set the local cache to `~/caveData/`
|
||||
|
||||
### Run CAVE
|
||||
|
|
@ -63,7 +74,6 @@ To run CAVE either:
|
|||
|
||||
- Use the terminal and type the command `cave`
|
||||
- Find the application in the Linux Desktop menu: Applications > Internet > AWIPS CAVE
|
||||
- Double click on the Desktop icon labeled "AWIPS CAVE"
|
||||
|
||||
Additionally users can choose to run a [virtual machine (VM)](#linux-virtual-machine) on Linux.
|
||||
|
||||
|
|
@ -71,7 +81,7 @@ Additionally users can choose to run a [virtual machine (VM)](#linux-virtual-mac
|
|||
|
||||
## Windows <i class="fa fa-windows"></i>
|
||||
|
||||
**Latest Version: 23.4.1-0.3**
|
||||
**Latest Version: 20.3.2-2**
|
||||
|
||||
For Windows, we offer two installation options: a [**Direct Windows Installation**](#method-1-direct-windows-install), or a [**Linux Virtual Machine**](#method-2-linux-virtual-machine).
|
||||
|
||||
|
|
@ -94,7 +104,7 @@ If you already have CAVE installed:
|
|||
|
||||
#### Download and Installation Instructions
|
||||
|
||||
1. Download and install: [**awips-cave.msi** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/windows/awips-cave-23.4.1-0.3.msi)
|
||||
1. Download and install: [**awips-cave.msi** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/windows/awips-cave.msi)
|
||||
|
||||
#### Run CAVE
|
||||
|
||||
|
|
@ -106,7 +116,7 @@ To run CAVE, either:
|
|||
|
||||
#### System-Level Installation
|
||||
|
||||
If you need a system-level installation of CAVE, please fill out [this brief access form](https://docs.google.com/forms/d/e/1FAIpQLSfQ0ZBf-zq-S50nXV1R3spa6nEnZ7VTEHO8r1iW604QF-vHbA/viewform?usp=sf_link) for the .msi, and then proceed with installation similar to that described above.
|
||||
If you need a system-level installation of CAVE, please fill out [this brief access form](https://docs.google.com/forms/d/e/1FAIpQLScLLR1JGh_DHESBSc6W0TVlslhNojT5OJF3WiTCajXg7CjWTA/viewform?usp=sf_link) for the .msi, and then proceed with installation similar to that described above.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -140,11 +150,12 @@ If you already have CAVE installed you can either:
|
|||
|
||||
#### Download and Installation Instructions
|
||||
|
||||
1. Download the zipped file containing the virtual machine: [**Rocky8-NSFUnidata-CAVE-23.4.1-0.3** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/windows/Rocky8-NSFUnidata-CAVE-23.4.1-0.3.zip)
|
||||
1. Download the zipped file containing the virtual machine: [**CentOS7-Unidata-CAVE-20.3.2-2** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/windows/unidata_cave.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 **Rocky8-NSFUnidata-CAVE-23.4.1-0.3.vmx"**.
|
||||
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-2.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" with sudo access
|
||||
- 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
|
||||
|
||||
|
|
@ -154,12 +165,11 @@ 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
|
||||
|
||||
|
||||
---
|
||||
|
||||
## macOS <i class="fa fa-apple"></i>
|
||||
|
||||
**Latest Version: 23.4.1-0.3**
|
||||
**Latest Version: 20.3.2-2**
|
||||
|
||||
### System Requirements
|
||||
|
||||
|
|
@ -177,7 +187,7 @@ If you already have CAVE installed:
|
|||
|
||||
### Download and Installation Instructions
|
||||
|
||||
1. Download and install CAVE: [awips-cave.dmg](https://downloads.unidata.ucar.edu/awips2/23.4.1/mac/awips-cave-23.4.1-0.3.dmg)
|
||||
1. Download and install CAVE: [awips-cave.dmg](https://downloads.unidata.ucar.edu/awips2/current/mac/awips-cave.dmg)
|
||||
|
||||
- You can click and drag the CAVE icon into the Applications Directory to install at the System Application level -- this may require Administrator Privileges
|
||||
- You can drag that icon to any other location (Desktop, local user's Applications directory, etc) to install CAVE at that location -- this will not require Administrator Privileges
|
||||
|
|
@ -196,9 +206,9 @@ To run CAVE either:
|
|||
|
||||
## 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**.
|
||||
NSF 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-cloud.unidata.ucar.edu**.
|
||||
|
||||
<center></center>
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -209,11 +219,16 @@ After connecting to an EDEX server, you will have a local directory named **cave
|
|||
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\`
|
||||
|
||||
---
|
||||
|
||||
## Uninstalling CAVE (Linux)
|
||||
These are instructions to manually uninstall CAVE manually. However, the [`awips_install-v23.sh`](#download-and-installation-instructions) script will do these steps for you if you are installing a newer version of CAVE.
|
||||
## Uninstalling CAVE
|
||||
|
||||
### Linux
|
||||
|
||||
These are instructions to manually uninstall CAVE. However, the [`awips_install.sh`](#download-and-installation-instructions) script will do these steps for you if you are installing a newer version of CAVE.
|
||||
|
||||
**1. Make sure you have exited out of any CAVE sessions**
|
||||
|
||||
|
|
@ -242,4 +257,18 @@ sudo yum remove awips2-*
|
|||
```
|
||||
rm -rf /awips2/cave
|
||||
rm -rf ~/caveData
|
||||
```
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
To completely remove CAVE:
|
||||
|
||||
1. Type "remove" in the search bar and select **Add or remove programs**. This will open the Applications settings.
|
||||
2. From here, find **AWIPS CAVE** and select "Uninstall".
|
||||
|
||||
### macOS
|
||||
|
||||
To completely remove CAVE:
|
||||
|
||||
1. Find where it is installed (might be the **Applications** folder) and drag into the trash.
|
||||
2. Then <a href="/awips2/appendix/common-problems#mac" target="_blank">remove caveData</a>.
|
||||
|
|
@ -1,25 +1,27 @@
|
|||
# Install CAVE
|
||||
# Install CAVE - BETA Version
|
||||
|
||||
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.
|
||||
|
||||
>Note: This release is still in beta since the National Weather Service (NWS) is still working on their 23.4.1 release to operations. In the interim, we are waiting on final clearance from the NWS before releasing a production (non-beta) version and source code.
|
||||
|
||||
---
|
||||
|
||||
## Latest CAVE Versions
|
||||
|
||||
- [**Linux: 20.3.2-2**](#linux)
|
||||
- [**Windows: 20.3.2-2**](#windows)
|
||||
- [**Mac: 20.3.2-2**](#macos)
|
||||
- [**BETA Version 23.4.1-0.3**](install-cave-beta-v23.md) (Compatible with RHEL/Rocky8)
|
||||
- [**Linux: 23.4.1-0.4**](#linux)
|
||||
- [**Windows: 23.4.1-0.4**](#windows)
|
||||
- [**Mac: 23.4.1-0.4**](#macos)
|
||||
- [**20.3.2**](install-cave-v20.md) (Compatible with EOL CentOS/Redhat 7)
|
||||
|
||||
[**View release notes**](https://www.unidata.ucar.edu/blogs/news/tags/awips-release)
|
||||
|
||||
!!! note "Major versions of CAVE and EDEX are not always cross compatible. Please use the same version CAVE to connect to the same version EDEX to ensure proper functionality."
|
||||
!!! note "Version 23.\* of CAVE is not compatible with Version 20.\* EDEX and vice versa, Version 20.\* of CAVE is not compatible with Version 23.\* EDEX."
|
||||
|
||||
---
|
||||
|
||||
## Functionality/Reporting
|
||||
|
||||
If you come across issues/bugs/missing functionality, we also encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLSehkNYMNb5G-_kfAEWN1sEPfcePawmN4kUp4IyIoWqRXtoZCw/viewform?usp=sf_link" target="_blank">report it using this short form</a>.
|
||||
If you come across issues/bugs/missing functionality, we encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLScqWZho98cI8ByYTe99YRidfiYK_VeHvjsAculZmiVdWGwUnw/viewform?usp=sf_link" target="_blank">report it using this short form</a> or emailing at support-awips@unidata.ucar.edu.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -29,8 +31,8 @@ Regardless of what Operating System CAVE is running on, these general requiremen
|
|||
|
||||
- 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."
|
||||
|
||||
!!! error "Running CAVE via X11 forwarding or ssh tunneling is **not** supported. Using a [remote desktop connection like VNC is the only remote option(../appendix/common-problems.md#remotely-connecting-to-cave), but may result in worse performance than running locally."
|
||||
|
||||
- OpenGL 2.0 Compatible Devices
|
||||
- At least 4GB RAM
|
||||
- At least 2GB Disk Space for Caching
|
||||
|
|
@ -43,27 +45,19 @@ Regardless of what Operating System CAVE is running on, these general requiremen
|
|||
|
||||
## Linux <i class="fa fa-linux"></i>
|
||||
|
||||
**Latest Version: 20.3.2-2**
|
||||
**Latest Version: 23.4.1-0.4**
|
||||
|
||||
### System Requirements
|
||||
|
||||
- 64 bit CentOS/Red Hat 7
|
||||
- 64 bit Rocky/Red Hat 8
|
||||
- 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."
|
||||
|
||||
### Upgrade Existing Installation
|
||||
|
||||
Whether you have CAVE currently installed or not, you can follow the [Download and Installation Instructions](#download-and-installation-instructions) below. The script will remove the old version of CAVE if needed, and install the latest version.
|
||||
|
||||
If you would like to completely remove CAVE, please see the [uninstall instructions further down this page](#linux_1).
|
||||
|
||||
### Download and Installation Instructions
|
||||
|
||||
1. Download the following installer: [**awips_install.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/linux/awips_install.sh)
|
||||
1. Download the following installer: [**awips_install-v23.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/linux/awips_install-v23.sh)
|
||||
2. In a terminal, go to the download directory
|
||||
3. Make the installer an executable by running: `chmod 755 awips_install.sh`
|
||||
4. Run the installer: `sudo ./awips_install.sh --cave`
|
||||
3. Make the installer an executable by running: `chmod 755 awips_install-v23.sh`
|
||||
4. Run the installer: `sudo ./awips_install-v23.sh --cave`
|
||||
- This will install the application in `/awips2/cave/` and set the local cache to `~/caveData/`
|
||||
|
||||
### Run CAVE
|
||||
|
|
@ -72,6 +66,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
|
||||
- Double click on the Desktop icon labeled "AWIPS CAVE"
|
||||
|
||||
Additionally users can choose to run a [virtual machine (VM)](#linux-virtual-machine) on Linux.
|
||||
|
||||
|
|
@ -79,7 +74,7 @@ Additionally users can choose to run a [virtual machine (VM)](#linux-virtual-mac
|
|||
|
||||
## Windows <i class="fa fa-windows"></i>
|
||||
|
||||
**Latest Version: 20.3.2-2**
|
||||
**Latest Version: 23.4.1-0.4**
|
||||
|
||||
For Windows, we offer two installation options: a [**Direct Windows Installation**](#method-1-direct-windows-install), or a [**Linux Virtual Machine**](#method-2-linux-virtual-machine).
|
||||
|
||||
|
|
@ -102,7 +97,7 @@ If you already have CAVE installed:
|
|||
|
||||
#### Download and Installation Instructions
|
||||
|
||||
1. Download and install: [**awips-cave.msi** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/windows/awips-cave.msi)
|
||||
1. Download and install: [**awips-cave.msi** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/windows/awips-cave-23.4.1-0.4.msi)
|
||||
|
||||
#### Run CAVE
|
||||
|
||||
|
|
@ -114,17 +109,19 @@ To run CAVE, either:
|
|||
|
||||
#### System-Level Installation
|
||||
|
||||
If you need a system-level installation of CAVE, please fill out [this brief access form](https://docs.google.com/forms/d/e/1FAIpQLScLLR1JGh_DHESBSc6W0TVlslhNojT5OJF3WiTCajXg7CjWTA/viewform?usp=sf_link) for the .msi, and then proceed with installation similar to that described above.
|
||||
If you need a system-level installation of CAVE, please fill out [this brief access form](https://docs.google.com/forms/d/e/1FAIpQLSfQ0ZBf-zq-S50nXV1R3spa6nEnZ7VTEHO8r1iW604QF-vHbA/viewform?usp=sf_link) for the .msi, and then proceed with installation similar to that described above.
|
||||
|
||||
---
|
||||
|
||||
### Method 2: Linux Virtual Machine
|
||||
### Method 2: Virtual Machine running Rocky8
|
||||
|
||||
Please note, running CAVE in a Virtual Machine does have reduced functionality than running CAVE directly on hardware (ex: rendering RGB satellite images).
|
||||
This virtual machine can be installed on Windows or Linux. Please note, running CAVE in a Virtual Machine does have reduced functionality than running CAVE directly on hardware (ex: rendering RGB satellite images).
|
||||
|
||||
#### System Requirements
|
||||
|
||||
- [VMWare Workstation Player](https://downloads.unidata.ucar.edu/awips2/current/windows/VMware-player-17.5.2-23775571.exe) must be installed (free software):
|
||||
- VMWare Workstation Pro (Free for personal use, but requires [creating an account](https://profile.broadcom.com/web/registration) with Broadcom) For more information on how to download click [here](vmware.md).
|
||||
OR
|
||||
- VMWare Workstation Player - [Version 17.5.2](https://downloads.unidata.ucar.edu/awips2/current/windows/VMware-player-17.5.2-23775571.exe) (this is an older version)
|
||||
- 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
|
||||
|
|
@ -132,7 +129,8 @@ Please note, running CAVE in a Virtual Machine does have reduced functionality t
|
|||
1. Select the "Change high DPI settings" button
|
||||
1. Check the "High DPI scaling override" checkbox and choose "Application" in the enabled dropdown
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Upgrade Existing Installation
|
||||
|
||||
|
|
@ -140,26 +138,26 @@ If you do not currently have CAVE installed, please go directly to the [Download
|
|||
|
||||
If you already have CAVE installed you can either:
|
||||
|
||||
- Download the new Virtual Machine ([as described below](#download-and-installation-instructions_2)) and you will see the new VM in VMware, similar to this screenshot:
|
||||
|
||||
|
||||
- Download a new Virtual Machine Image ([as described below](#download-and-installation-instructions_2))
|
||||
OR
|
||||
- Upgrade the version of CAVE within the Virtual Machine by following the [Linux instructions](#upgrade-existing-installation)
|
||||
|
||||
|
||||
#### Download and Installation Instructions
|
||||
|
||||
1. Download the zipped file containing the virtual machine: [**CentOS7-Unidata-CAVE-20.3.2-2** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/windows/unidata_cave.zip)
|
||||
1. Download the zipped file containing the virtual machine: [**Rocky8-NSFUnidata-CAVE-23.4.1-0.4** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/windows/Rocky8-NSFUnidata-CAVE-23.4.1-0.4.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-2.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
|
||||
3. Open VMWare Workstation and go to **File...** > **Open** and locate the folder that was created from the downloaded unzipped file. Select the file called **Rocky8-NSFUnidata-CAVE-23.4.1-0.4.vmx"**.
|
||||
4. This will open a new tab in VMWare Workstation, click "Power on this virtual machine". If it asks if it's been moved or copied, select **"I Copied It"**.
|
||||
|
||||
|
||||
5. There will be a user on the Linux machine named "awips" and the password is "awips" with sudo access
|
||||
|
||||
#### Run CAVE
|
||||
|
||||
Once inside the VM, to run CAVE either:
|
||||
|
||||
- Use the desktop icon
|
||||
- Use the desktop icon
|
||||
- Use the terminal and type the command `cave`
|
||||
- Find the application in the Linux Desktop menu: Applications > Internet > AWIPS CAVE
|
||||
|
||||
|
|
@ -167,7 +165,7 @@ Once inside the VM, to run CAVE either:
|
|||
|
||||
## macOS <i class="fa fa-apple"></i>
|
||||
|
||||
**Latest Version: 20.3.2-2**
|
||||
**Latest Version: 23.4.1-0.4**
|
||||
|
||||
### System Requirements
|
||||
|
||||
|
|
@ -185,7 +183,7 @@ If you already have CAVE installed:
|
|||
|
||||
### Download and Installation Instructions
|
||||
|
||||
1. Download and install CAVE: [awips-cave.dmg](https://downloads.unidata.ucar.edu/awips2/current/mac/awips-cave.dmg)
|
||||
1. Download and install CAVE: [awips-cave.dmg](https://downloads.unidata.ucar.edu/awips2/23.4.1/mac/awips-cave-23.4.1-0.4.dmg)
|
||||
|
||||
- You can click and drag the CAVE icon into the Applications Directory to install at the System Application level -- this may require Administrator Privileges
|
||||
- You can drag that icon to any other location (Desktop, local user's Applications directory, etc) to install CAVE at that location -- this will not require Administrator Privileges
|
||||
|
|
@ -204,9 +202,9 @@ To run CAVE either:
|
|||
|
||||
## EDEX Connection
|
||||
|
||||
NSF 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-cloud.unidata.ucar.edu**.
|
||||
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**.
|
||||
|
||||
|
||||
<center></center>
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -217,16 +215,11 @@ After connecting to an EDEX server, you will have a local directory named **cave
|
|||
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\`
|
||||
|
||||
---
|
||||
|
||||
## Uninstalling CAVE
|
||||
|
||||
### Linux
|
||||
|
||||
These are instructions to manually uninstall CAVE. However, the [`awips_install.sh`](#download-and-installation-instructions) script will do these steps for you if you are installing a newer version of CAVE.
|
||||
## Uninstalling CAVE (Linux)
|
||||
These are instructions to manually uninstall CAVE manually. However, the [`awips_install-v23.sh`](#download-and-installation-instructions) script will do these steps for you if you are installing a newer version of CAVE.
|
||||
|
||||
**1. Make sure you have exited out of any CAVE sessions**
|
||||
|
||||
|
|
@ -255,18 +248,4 @@ sudo yum remove awips2-*
|
|||
```
|
||||
rm -rf /awips2/cave
|
||||
rm -rf ~/caveData
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
To completely remove CAVE:
|
||||
|
||||
1. Type "remove" in the search bar and select **Add or remove programs**. This will open the Applications settings.
|
||||
2. From here, find **AWIPS CAVE** and select "Uninstall".
|
||||
|
||||
### macOS
|
||||
|
||||
To completely remove CAVE:
|
||||
|
||||
1. Find where it is installed (might be the **Applications** folder) and drag into the trash.
|
||||
2. Then <a href="/awips2/appendix/common-problems#mac" target="_blank">remove caveData</a>.
|
||||
```
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Install EDEX - <span style="color:red">BETA Version!</span>
|
||||
# Install EDEX
|
||||
|
||||
EDEX is the **E**nvironmental **D**ata **Ex**change system that represents the backend server for AWIPS. EDEX is only supported for Linux systems: CentOS and RHEL, and ideally, it should be on its own dedicated machine. It requires administrator priviledges to make root-level changes. EDEX can run on a single machine or be spread across multiple machines. To learn more about that please look at [Distributed EDEX, Installing Across Multiple Machines](../../edex/distributed-computing/)
|
||||
|
||||
|
|
@ -6,7 +6,10 @@ EDEX is the **E**nvironmental **D**ata **Ex**change system that represents the b
|
|||
|
||||
## Latest Version
|
||||
|
||||
**23.4.1-0.3**
|
||||
>Note: Version 20* of CAVE and EDEX runs on CentOS7 which was End of Life (EOL) on Jun 30, 2024. Unidata is still running a public version 20.3.2 EDEX and has CAVE installers available for the time being until we can officially release version 23 in a non-beta form. This will happen once the National Weather Service (NWS) officially releases 23.4.1 to operations.
|
||||
|
||||
- **20.3.2-2**
|
||||
- [**BETA Version 23.4.1-0.3**](install-edex.md) (Compatible with RHEL/Rocky8)
|
||||
|
||||
[**View release notes**](https://www.unidata.ucar.edu/blogs/news/tags/awips-release)
|
||||
|
||||
|
|
@ -16,22 +19,26 @@ EDEX is the **E**nvironmental **D**ata **Ex**change system that represents the b
|
|||
|
||||
## Functionality/Reporting
|
||||
|
||||
This is a beta release, so we are aware that not all functionality is working as expected. We ask you to please be aware of this and have similar expectations. If you come across issues/bugs/missing functionality, we also encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLScqWZho98cI8ByYTe99YRidfiYK_VeHvjsAculZmiVdWGwUnw/viewform?usp=sf_link" target="_blank">report it using this short form</a>.
|
||||
If you come across issues/bugs/missing functionality, we also encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLSf6jyZtbh49g-GCBoAQYzTVwAIf_aKz0QOeAr7gDVFhPrjAmw/viewform?usp=sf_link">report it using this short form</a>.
|
||||
|
||||
---
|
||||
|
||||
|
||||
## System requirements
|
||||
|
||||
- 64-bit Rocky/RHEL 8
|
||||
- 64-bit CentOS/RHEL 7
|
||||
|
||||
!!! note "While CentOS8 has reach End of Life as of Dec. 31, 2021, CentOS7 End of Life isn't until June 30, 2024."
|
||||
|
||||
- Bash shell environment
|
||||
- 16+ CPU cores (each CPU core can run a decorder in parallel)
|
||||
- 24GB RAM
|
||||
- 700GB+ Disk Space
|
||||
- gcc-c++ package
|
||||
- A **Solid State Drive (SSD)** is recommended
|
||||
- A SSD should be mounted either to `/awips2` (to contain the entire EDEX system) or to `/awips2/edex/data/hdf5` (to contain the large files in the decoded data store). EDEX can scale to any system by adjusting the incoming LDM data feeds or adjusting the resources (CPU threads) allocated to each data type.
|
||||
|
||||
!!! note "EDEX is only supported for 64-bit Rocky and RHEL 8 Operating Systems."
|
||||
!!! note "EDEX is only supported for 64-bit CentOS and RHEL 7 Operating Systems."
|
||||
|
||||
!!! warning "EDEX is **not** supported in Debian, Ubuntu, SUSE, Solaris, macOS, or Windows. You may have luck with Fedora Core 12 to 14 and Scientific Linux, but we will not provide support."
|
||||
|
||||
|
|
@ -43,10 +50,10 @@ The first 3 steps should all be run as **root**
|
|||
|
||||
### 1. Install EDEX
|
||||
|
||||
Download and run the installer: [**awips_install-v23.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/linux/awips_install-v23.sh)
|
||||
Download and run the installer: [**awips_install.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/linux/awips_install.sh)
|
||||
|
||||
```
|
||||
wget https://downloads.unidata.ucar.edu/awips2/23.4.1/linux/awips_install-v23.sh
|
||||
wget https://downloads.unidata.ucar.edu/awips2/current/linux/awips_install.sh
|
||||
chmod 755 awips_install.sh
|
||||
sudo ./awips_install.sh --edex
|
||||
```
|
||||
|
|
@ -167,12 +174,10 @@ edex start
|
|||
```
|
||||
To manually start, stop, and restart:
|
||||
```
|
||||
systemctl start postgres@awips
|
||||
systemctl start httpd-pypies
|
||||
systemctl start qpidd
|
||||
systemctl start edex_camel@ingest
|
||||
systemctl start edex_camel@ingestGrib
|
||||
systemctl start edex_camel@request
|
||||
service edex_postgres start
|
||||
service httpd-pypies start
|
||||
service qpidd start
|
||||
service edex_camel start
|
||||
```
|
||||
The fifth service, **edex_ldm**, does **not run at boot** to prevent filling up disk space if EDEX is not running. Start ldm manually:
|
||||
```
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Install EDEX
|
||||
# Install EDEX - BETA Version
|
||||
|
||||
EDEX is the **E**nvironmental **D**ata **Ex**change system that represents the backend server for AWIPS. EDEX is only supported for Linux systems: CentOS and RHEL, and ideally, it should be on its own dedicated machine. It requires administrator priviledges to make root-level changes. EDEX can run on a single machine or be spread across multiple machines. To learn more about that please look at [Distributed EDEX, Installing Across Multiple Machines](../../edex/distributed-computing/)
|
||||
|
||||
|
|
@ -6,8 +6,9 @@ EDEX is the **E**nvironmental **D**ata **Ex**change system that represents the b
|
|||
|
||||
## Latest Version
|
||||
|
||||
- **20.3.2-2**
|
||||
- [**BETA Version 23.4.1-0.3**](install-edex-beta-v23.md) (Compatible with RHEL/Rocky8)
|
||||
>Note: This release is still in beta since the National Weather Service (NWS) is still working on their 23.4.1 release to operations. In the interim, we are waiting on final clearance from the NWS before releasing a production (non-beta) version and source code.
|
||||
- **23.4.1-0.4**
|
||||
- [**20.3.2**](install-edex-v20.md) (Compatible with EOL CentOS/Redhat 7)
|
||||
|
||||
[**View release notes**](https://www.unidata.ucar.edu/blogs/news/tags/awips-release)
|
||||
|
||||
|
|
@ -17,26 +18,22 @@ EDEX is the **E**nvironmental **D**ata **Ex**change system that represents the b
|
|||
|
||||
## Functionality/Reporting
|
||||
|
||||
If you come across issues/bugs/missing functionality, we also encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLSf6jyZtbh49g-GCBoAQYzTVwAIf_aKz0QOeAr7gDVFhPrjAmw/viewform?usp=sf_link">report it using this short form</a>.
|
||||
If you come across issues/bugs/missing functionality, we encourage you to <a href="https://docs.google.com/forms/d/e/1FAIpQLScqWZho98cI8ByYTe99YRidfiYK_VeHvjsAculZmiVdWGwUnw/viewform?usp=sf_link" target="_blank">report it using this short form</a> or emailing at support-awips@unidata.ucar.edu.
|
||||
|
||||
---
|
||||
|
||||
|
||||
## System requirements
|
||||
|
||||
- 64-bit CentOS/RHEL 7
|
||||
|
||||
!!! note "While CentOS8 has reach End of Life as of Dec. 31, 2021, CentOS7 End of Life isn't until June 30, 2024."
|
||||
|
||||
- 64-bit Rocky/RHEL 8
|
||||
- Bash shell environment
|
||||
- 16+ CPU cores (each CPU core can run a decorder in parallel)
|
||||
- 16+ CPU cores (each CPU core can run a decoder in parallel)
|
||||
- 24GB RAM
|
||||
- 700GB+ Disk Space
|
||||
- gcc-c++ package
|
||||
- A **Solid State Drive (SSD)** is recommended
|
||||
- A SSD should be mounted either to `/awips2` (to contain the entire EDEX system) or to `/awips2/edex/data/hdf5` (to contain the large files in the decoded data store). EDEX can scale to any system by adjusting the incoming LDM data feeds or adjusting the resources (CPU threads) allocated to each data type.
|
||||
|
||||
!!! note "EDEX is only supported for 64-bit CentOS and RHEL 7 Operating Systems."
|
||||
!!! note "EDEX is only supported for 64-bit Rocky and RHEL 8 Operating Systems."
|
||||
|
||||
!!! warning "EDEX is **not** supported in Debian, Ubuntu, SUSE, Solaris, macOS, or Windows. You may have luck with Fedora Core 12 to 14 and Scientific Linux, but we will not provide support."
|
||||
|
||||
|
|
@ -48,10 +45,10 @@ The first 3 steps should all be run as **root**
|
|||
|
||||
### 1. Install EDEX
|
||||
|
||||
Download and run the installer: [**awips_install.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/current/linux/awips_install.sh)
|
||||
Download and run the installer: [**awips_install-v23.sh** <i class="fa fa-download"></i>](https://downloads.unidata.ucar.edu/awips2/23.4.1/linux/awips_install-v23.sh)
|
||||
|
||||
```
|
||||
wget https://downloads.unidata.ucar.edu/awips2/current/linux/awips_install.sh
|
||||
wget https://downloads.unidata.ucar.edu/awips2/23.4.1/linux/awips_install-v23.sh
|
||||
chmod 755 awips_install.sh
|
||||
sudo ./awips_install.sh --edex
|
||||
```
|
||||
|
|
@ -172,10 +169,12 @@ edex start
|
|||
```
|
||||
To manually start, stop, and restart:
|
||||
```
|
||||
service edex_postgres start
|
||||
service httpd-pypies start
|
||||
service qpidd start
|
||||
service edex_camel start
|
||||
systemctl start postgres@awips
|
||||
systemctl start httpd-pypies
|
||||
systemctl start qpidd
|
||||
systemctl start edex_camel@ingest
|
||||
systemctl start edex_camel@ingestGrib
|
||||
systemctl start edex_camel@request
|
||||
```
|
||||
The fifth service, **edex_ldm**, does **not run at boot** to prevent filling up disk space if EDEX is not running. Start ldm manually:
|
||||
```
|
||||
|
|
|
|||
|
|
@ -16,14 +16,19 @@ To stop all EDEX services:
|
|||
|
||||
## Service and Boot Settings
|
||||
|
||||
These commands will start and stop five EDEX service files installed into **/etc/init.d/**, four of which are run on boot:
|
||||
The main EDEX services are now stopped/started using systemd (`systemctl`). The services that used to be **/etc/init.d/**, have been removed starting in v23.4.1 (Redhat/Rocky8). Additionally, the each edex_camel service needs to be started manually. The services below are set to start up on boot.
|
||||
|
||||
service postgres start
|
||||
service httpd-pypies start
|
||||
service qpidd start
|
||||
service edex_camel start
|
||||
To manually start, stop, and restart:
|
||||
```
|
||||
systemctl start postgres@awips
|
||||
systemctl start httpd-pypies
|
||||
systemctl start qpidd
|
||||
systemctl start edex_camel@ingest
|
||||
systemctl start edex_camel@ingestGrib
|
||||
systemctl start edex_camel@request
|
||||
```
|
||||
|
||||
The fifth, `edex_ldm`, does **not run at boot** to prevent filling up disk space if EDEX is not running:
|
||||
The last service, `edex_ldm`, does **not run at boot** to prevent filling up disk space if EDEX is not running:
|
||||
|
||||
service edex_ldm start
|
||||
|
||||
|
|
@ -176,11 +181,13 @@ To see a list of clients connecting to your EDEX server, use the `edex users [YY
|
|||
|
||||
edex users
|
||||
|
||||
-- EDEX Users 20160826 --
|
||||
user@101.253.20.225
|
||||
user@192.168.1.67
|
||||
awips@0.0.0.0
|
||||
awips@sdsmt.edu
|
||||
|
||||
-- EDEX Users 20241022 --
|
||||
angel@192.168.1.158
|
||||
awips@192.168.1.1
|
||||
WeatherCenter@10.196.1.34
|
||||
----------
|
||||
3 users today!
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
21
docs/install/vmware.md
Normal file
21
docs/install/vmware.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# VMWare Workstation Pro - Available
|
||||
|
||||
In 2024, Broadcom bought VMware and since then the download process of the free VMWare Workstation application has changed and become slightly more difficult. **VMWare Workstation Player** is no longer available, but the **VMWare Workstation Pro** version is now avialable for free personal use. Below will describe how to register for an account and download the latest release.
|
||||
|
||||
1. First you must [register](https://profile.broadcom.com/web/registration) and create an account with broadcom.
|
||||
|
||||
|
||||
|
||||
2. After entering in your email, you will receive an email from Broadcom with a verification code to continue with the account creation.
|
||||
3. Complete your registration by entering in your information, password, and accepting the terms of use.
|
||||
4. Once registered, [login](https://support.broadcom.com/web/ecx/home) into Broadcom's webpage
|
||||
5. Go to the [VMWare Workstation Pro Downloads page](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware+Workstation+Pro)
|
||||
6. Select the arrow next to the "VMware Workstation Pro for Personal Use" and select the version you want to download.
|
||||
|
||||
|
||||
|
||||
7. At this point, if this is your first time, you won't be able to actually download the product until you go through the very simple screening process. Start by checking the "I agree to Terms and Conditions" and then the Download button.
|
||||
|
||||
|
||||
|
||||
8. Complete the rest of the verification and then you'll be able to download the installer.
|
||||
Loading…
Add table
Reference in a new issue