Skip to content

New InVEST Model Release Checklist

Jump to bottom
Claire Simpson edited this page Mar 23, 2026 · 1 revision

This checklist is intended to standardize the release process for new InVEST models. The primary pieces of a new model are: the model itself, report, sample/test data, User Guide, comms, forum tag and post, website update.

1. Initial Planning

  • Finalize PEP and design doc
  • Identify model owner(s)
    • PEP proposer (who will also likely be in charge of sample data and User Guide);
    • Software lead
  • Notify Comms team of upcoming model + rough timeline (~3 months ahead if possible)
  • Notify Training team (if training materials will be created)

2. Development

Implementation

  • Software team implements model per PEP/design doc and in close collaboration with the science lead (others may lead development in the future), including:
    • Writing reporter module
    • Writing a comprehensive test suite
    • Adding model to HISTORY.rst
      • Add to release notes
      • Add to model header list (alphabetical list of InVEST model names at top of HISTORY)
    • Updating requirements if needed
  • Software team creates new forum tag
    • Software lead updates model’s ID in FORUM_TAGS list in ‎workbench/src/renderer/components/ResourcesLinks/index.jsx‎

Sample Data

  • PEP proposer leads creation of sample data (following sample data guidelines)
    • GIS analysts and software lead review
  • Sample data must have metadata (GeoMetaMaker YAMLs)
    • PEP proposer ensures that citations and descriptions are manually filled in

User Guide

  • PEP proposer leads development of the User Guide chapter, following the User Guide template. A User Guide style guide currently exists here. It has begun being updated to make it as useful as possible for new model authors.
  • Software lead, GIS analysts (and others?) review (via GH) when this is ready

3. Release Candidate (≥2 weeks before release)

  • Software lead creates release candidate build and distributes to NatCap staff (including PEP proposer and GIS team) for beta testing. (Note that the software and science leads are expected to have communicated throughout development, so this phase should primarily focus on minor issues rather than major changes.)
    • Shares sample datastack alongside dev build; testers should review this
    • Shares report and solicits feedback on this
    • Ensures model is tested on macOS/Windows/Linux
    • Collects feedback and fixes bugs / polishes UX

4. Pre-Release Finalization

Documentation & Outputs

  • PEP proposer finalizes User Guide chapter and merges PR into UG repo
  • PEP proposer (or science lead) finalizes sample data (and test data, if applicable) + metadata and software lead merges into Bitbucket repo(s)

Comms

  • Software team confirms release timing with Comms
    • Software team or science lead provides:
      • Model description
      • Key features / impact
  • Comms team leads creation of social/media content, website updates, and optionally a short advertising video

Translations

  • Software team leads the translations, working closely with the PEP proposer and others. The translation process is dependent on completion of the User Guide and InVEST model. This could occur ahead of release or shortly following in the next bugfix release.

5. Release occurs!

6. Post-Release

Clone this wiki locally