This repository hosts a GUI-based application of the Weather Research and Forecasting Model (WRF) on a Raspberry Pi (version 3 or higher). The following text can be summarized into a few instructions to install and run the application. :

1. Open a terminal
2. Type curl -sSL https://get.docker.com | sh
3. Type sudo docker run -it --rm --net=host -e DISPLAY -v $HOME/.Xauthority:/root/.Xauthority ncar/pi-wrf

The Pi-WRF application requires an internet connection, and the container platform Docker to run. In short, Docker is a is a platform that creates containers, which simulates the software of a different computer, all within your own computer. If you are familiar with the term virtual machine, then containers are light-weight forms of virtual machines. The containers Docker creates are self-contained, and code/programs within the container do no affect any of the files or security on your host system.

In order to run the Pi-WRF application, you will need to download and install Docker. Once this is completed, you will then download a Docker image and create a container which houses the Pi-WRF application. After the container is created you will run the program. The following instructions will inform you of how to download and install docker, create a container, and run the app.

1. Open a terminal by clicking on the following icon in the upper left of your screen. If you do not see the icon, you may press the following keys:
   Control + Alt + t

2. Download and install Docker (this may take upwards of 10 minutes) by typing the following in the terminal. This step only needs to be done once. Subsequent use of the app will not require this step.:
   curl -sSL https://get.docker.com | sh:
   

3. Download a Docker image and create a container that holds the WRF app by typing the following (all in one line):
   sudo docker run -it --rm --net=host -e DISPLAY -v $HOME/.Xauthority:/root/.Xauthority ncar/pi-wrf

After the app launches, the user will select the time to start/initialize the model, set the model’s duration, select the domain of the model, and then run the model. In order to use the application, the raspberry Pi must be connected to the internet. :

1. Click “Run Forecast” to Start :
   
2. Choose the day and time to run the simulation (Must run a simulation that is initialized within 48 hours of the current time, and we recommend running a simulation smaller than 1,000 grid cells):
   
3. Click “Run Model” button to start. A view output button will show when the model finishes:
   

If you no longer wish to have the app or Docker installed on your Raspberry Pi you can remove all components without affected your Pi. To uninstall Docker and remove all containers you must enter the following commands into your terminal.:

1. Remove all containers:
   sudo docker system prune -a:
   

2. Remove all images:
   sudo docker rmi $(docker images -a -q):
   

3. Remove Docker:
   Sudo apt remove docker-ce:
   

This section is for users who have modified the WRF source code. Make your changes to the source code and then run the following commands to build a new Docker Image. Warning: This may take a few hours to complete.

1. CD into the top level directory

2. Build the image with the command :
   docker build -f envs/smpar_gui/dockerfile .

1. App is not exiting To force the app to quit press the following keys: Control + c

2. Not responsive at start At startup, the app loads. You will need to wait a few seconds once you see the home screen buttons. Once they highlight when you hover your mouse cursor over them, you may begin to use the app.

3. Cannot run global simulation Due to memory constraints of the Raspberry Pi, the app cannot run global simulations. Choose a smaller domain to run the model (we suggest less than 2,000 grid cells for efficiency).

4. I receive a segmentation error when running a simulation near the equator At the equator, large towering cumulus clouds that arise due to deep convection are prevalent throughout the year. These clouds are associated with very strong updrafts or quickly moving rising air. The air moves so fast within the model, that the air can skip a vertical grid cell. The model does not know how to handle blank grid cells, so it produces an error. This is resolved be reducing the time step so the air will not travel as far in a shorter amount of time.

5. Dates do not work Users are limited to a few days before the current date. Times prior to this are considered archived simulations and a collection of archive simulations will be included at a later version of the Pi-WRF application.