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
-
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.
-
The
docs
directory in the model repo has been replaced with a single page in theeps-docs
repo. Add a region doc page in thedocs/models
directory in theeps-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 followseps-
in the region's repo name. -
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. -
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
-
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.
-
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 theeps-app
repo. -
Copy a similar home config file and customize it.
-
Add a new
region_{id}
string for each language in theapp_str.json
file ineps app
. -
If the model will be translated, add the model to the
languages
list in the eps-buildconfig.mjs
file and translate the model strings.