When reporting a bug or usage problem in software developed by ACME, use this guide.
ACME develops many different pieces of software (The ACME model, UV-CDAT, diagnostic scripts). Depending on where the bug is located, there might be a different procedure. They are all described or pointed to here.
Reporting a bug in the ACME model source code
Any bug in the "master" branch of ACME should be reported as follows.
You will need an ACME github developer account. See the first 3 steps in Development Getting Started Guide
- Create a new issue in https://github.com/ACME-Climate/ACME/issues
- In the issue title, briefly describe what the bug does. Don't use the word "bug" or "error" in the title.
- In the body, give more detail on the bug including files involved (if known), the output of "git describe --dirty" (for bugs on master or maint) and how to reproduce the bug.
- Using the "Labels" menu, add the "bug" label to the issue if the bug is in master or a maint branch. Otherwise, use "PotentialBug".
- Also add a label for what component the bug appears in (atmosphere, land, ocean, etc.).
- Using the "Assignee" menu, assign the bug to one of the component integrators.
- If necessary, work with the integrator to better describe the bug or how to reproduce it.
See also:
- Fixing a bug: Development Reference#Creatinganewbranch:bugfix
- Making a pull request for bug fix: Development Reference#Submittingapullrequest
- Processing a bug: Integrator Guide#Processingabug
- /wiki/spaces/SE/pages/3997737
Reporting an issue on Request Hub
Cross-group requests and (possible) bugs can be reported at /wiki/spaces/CH/overview.
Reporting a bug in UV-CDAT or diagnostic scripts.
- Create a new issue in https://github.com/UV-CDAT/uvcdat/issues
- In the issue title, briefly describe the bug or problem.
- Choose appropriate tags. For ACME project related issues add label ACME to the issue. If you are a lead or a scientist mark the priority as High or Low.
- In the body, give more detail including how to reproduce the bug.
Reporting a bug in the UVCDAT diagnostics package (uvcmetrics)
Follow the general UV-CDAT reporting procedures, but report issues in https://github.com/UV-CDAT/uvcmetrics/issues
Reporting a bug in the ACME regridder
Follow the general UV-CDAT reporting procedures, but report issues in https://github.com/doutriaux1/regrid/issues
ACME Over-arching user interface
Still in development. Some information about this is on the page /wiki/spaces/WORKFLOW/pages/11010327.
There is another Github location with several repositories related to these activities:
Related articles