Skip to content

Contributor's Guide

Kate Fossell edited this page Sep 20, 2022 · 11 revisions

NOTICE

Effective October 1, 2022, the DTC has ceased all activities supporting this project. The resources associated with this project will remain available in their current state for community use until further notice.

container-dtc-nwp

The Developmental Testbed Center (DTC) developed NWP end-to-end systems in Docker containers for community use.

For general info on DTC NWP containers: https://dtcenter.org/community-code/numerical-weather-prediction-nwp-containers

For accessing the DTC NWP containers online tutorial: https://dtcenter.org/nwp-containers-online-tutorial/introduction

What can be contributed?

New Case Studies

Requirements

  • Description of case and configuration: A brief descriptions of the case of interest, model configuration and motivation for providing the case to the broader community.
  • ICBC data: Depending on size of data, we may be able to host a copy. Otherwise access to the necessary input data for initial and boundary conditions is required.
  • Scripts: Set of case-specific scripts designed in the same manner as those currently provided in the repository to run this new case.
  • Computation Reqs: Overview of computational requirements to run the case.

Procedures

  1. Post a message in the Customization category of the Discussions Board indicating your interest in contributing a new case to trigger a code manager assignment.
  2. Gather all of the requirements listed above.
  3. Thoroughly test the new case with the most recent release of the system.
  4. Work with code manager to finalize the contribution.

Bug Reports and Fixes

  1. Report the bug
    a. Create an Issue describing the bug. Or Post the issue on the Discussions board.
    b. Select the appropriate tags to indicate what parts of the system the bug affects.

  2. Submit a bug fix (if identified)
    a. Create a branch called feature/issue_[##]_[description]
    b. Apply the bug fix to that branch.
    c. Test the fix.
    d. Create a Pull Request using the Pull Request template to fill in the proper information.

Suggestions for Enhancements

Post a message under the Ideas category of the Discussions board.