Tasks to release the first version of a new model - EnergyInnovation/eps-us GitHub Wiki

To release the first version of a new EPS model (i.e. the first release of a particular EPS region), you need to follow the same steps as outlined in the checklist Tasks to release a new version of an existing model, with the following additions:

Tasks for EPS Team Member

  1. Inform the web developer of the upcoming release in advance. This gives the web developer time to build a new production server for the region and any other required preparatory tasks.

  2. Ensure that the web_assets folder in the latest commit contains:

    • the landing page background (2000 pixels width by 780 pixels height, with focal point right-of-center and a fade on the left side)
    • the social media sharing image (1200 pixels width by 630 pixels height, with focal point centered, no fade). This is typically based on the same source image as the landing page image but cropped differently and without a fade applied.
    • logo images for EI and for any partner organization (ideally .svg format, otherwise transparent-background .png)

  3. The docs directory in the model repo has been replaced with a single page in the eps-docs repo. Add a region doc page in the docs/models directory in the eps-docs repo. Copy the page for a similar region to get started. Rename it as {region}.md, where {region} is the same all lower-case region name that follows eps- in the region's repo name.

  4. Ensure that the "Software License and Image Credits" section in the doc page contains an "Image Credits" section containing source info for the image used as the landing page and social media image. Refer to the docs/models/us.md U.S. documentation page as an example.

Tasks for Web Developer

  1. Immediately before or after creating the release in GitHub, log into the EI Administrator GitHub account and change the region's repository privacy setting to "Public". Important Exception: Skip this step for regions where we agreed not to make the input data and model available for download, such as the China region with NCSC data and the Zhejiang region.

  2. Add the region to the region selector used on each region's landing page and the global landing page. Edit the static/js/region_cfg.json file in the eps-app repo.