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. 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.

  3. 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.

  4. If the model will be translated, ask the web developer for an Excel file of model strings to be translated. Send this to the translator, and then return it to the web developer.

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 region_cfg.json file in the eps-app repo.

  3. Copy a similar home config file and customize it.

  4. Add a new region_{id} string for each language in the app_str.json file in eps app.

  5. If the model will be translated, add the model to the languages list in the eps-build config.mjs file and translate the model strings.