Domain review
InQUIRI
Review of Please provide a PDF documenting this review. Here is the guidance provided on the USGS software management page:
Domain Review
Domain reviews are specific to Scientific Software (Refer to Scientific Software IM) and ensure the software generates output that aligns with published or otherwise well-known expected results. Domain reviews may involve:
Comparing output with external data sets
Comparing algorithms with published, scholarly articles about the algorithm
Reviewing unit and integration test results
Domain reviews should be performed by a trusted scientific expert with applicable subject-matter knowledge as well as sufficient applicable programming knowledge.
Review Checklist
Please check off boxes as you complete each check. If any issues are found for a given check, describe in comments below
Documentation
-
A statement of need or purpose: Check that the authors clearly state the scientific purpose or what problems the software is designed to solve -
Example usage: Check that the authors include examples of how to use the software (ideally to solve real-world analysis problems) -
Functionality documentation: Check that the core functionality of the software is documented to a satisfactory level (e.g., API method documentation) -
References: When present, check that references in the text use the proper citation syntax, (for example, by using pandoc)
Functionality
-
Functionality: Confirm that the functional claims of the software are accurate and align with the published, scholarly record -
Functionality: Compare output with external data sets, if applicable -
Scientific Rigor: Confirm that the methods applied are scientifically appropriate to address the research question -
Performance: If there are any performance claims of the software, confirm that they are accurate (If there are no claims, please check off this item.)
Review Comments
- [Add any review comments here]