Setting up a simple modeling hub#

Now we will go through the steps needed to set up and configure your modeling hub.

In order to work with the code in your hub, it is helpful to use software built for this purpose. In our example, we will be using RStudio to work with the code. If you choose to use RStudio, you will need to have R and Rstudio loaded on your computer. Here are directions for downloading R and RStudio.

In this example, we will be setting up a simple forecast hub in the style of the Simple Forecast Hub Example, which is adapted from forecasts submitted to the US COVID-19 Forecast Hub, but has been modified to provide examples of nowcasts.

1. Configuring your Modeling Hub#

The files within the hub-config directory specify general configurations for a hub as well as (possibly round-specific) details of what model outputs are requested or required. Details about these files can be found here.

2. Hub administrative configuration#

The first file that we will be working with is admin.json. This is the administrative hub configuration file containing generic information about the hub, as well as static configuration settings for downstream tools such as validations, visualizations, etc. These global administrative settings are expected to remain fixed throughout a hub’s existence and apply to all the modeling rounds for a hub.

Step 1: Find the repository in RStudio#

Open RStudio and go to where your repo is stored on your local computer, using the Files pane.

Screenshot of how to find repository in RStudio

Step 2: Open admin.json#

Click on the hub-config folder and open admin.json by clicking on it. It will appear in the upper left hand pane, which is called the ‘source pane’.

Screenshot of how to find the admin.json file in RStudio

Step 3: Examine the file#

You can find a description of each line of code in the admin.json file. In the example presented below, you can check the following details:

  • The maintainer is: “Simple Modeling Hub”

  • The contact person is: S Brown (sbrown@xxx.com)

  • The file format for submissions is” “csv”

The code can be edited directly on the ‘source pane’ and saved by clicking on the disk icon indicated by the red arrow below.

Screenshot of how to edit and save the admin.json file in RStudio

Congratulations!#

You are ready to configure the modeling tasks for your modeling hub.