Setting up a simple modeling hub

Setting up a simple modeling hub#

We will follow the steps to set up and configure your modeling hub.

Using software built to work with the code in your hub is helpful. In our example, we will use RStudio to work with the code. If you choose to use RStudio, you should have R and RStudio loaded on your computer. Click on the links to read directions for downloading R and directions for downloading RStudio.

In this example, we will set up a simple forecast hub in the style of the simple forecast hub example. This hub is adapted from forecasts submitted to the US COVID-19 Forecast Hub but modified to provide examples of nowcasts.

1. Configuring your modeling hub#

The files within the hub-config directory specify general hub configurations and (possibly round-specific) details of what model outputs are requested or required. The linked page provides more information about hub configuration files.

2. Hub administrative configuration#

The first file we will work with is admin.json. This administrative hub configuration file contains generic information about the hub and 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 the 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 called the ‘source pane’.

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

Step 3: Examine and edit 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@example.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.