ml-infrastructure

(In development) An agile framework for leveraging machine learning in numerical weather prediction research

Branches & PRs

For development, we recommend creating a branch off of develop following the below naming conventions:

• documentation/user_branch_name: Documenation additions and/or corrections
• feature/user_branch_name: Enhancements/upgrades
• fix/user_branch_name: Bug-type fixes
• hotfix/user_branch_name: Bug-type fixes which require immediate attention and are required to fix significant issues that compromise the integrity of the software

Once the desired contributions are complete in your branch, submit a pull request (PR) to merge your branch into develop. Also note that all python coding additions should follow the PEP8 style guide. We will use the "squash merge" feature on PRs that we merge to consolidate the commit history.

When features are completed (or other significant milestones worthy of a release are reached), we will open a PR to main and tag the release.

Disclaimer

The United States Department of Commerce (DOC) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. The DOC has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any claims against the Department of Commerce stemming from the use of its GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.