1. Scope

1.1 This guide covers suggested components of the documentation of a ground-water modeling code. Documentation of a ground-water modeling code consists of textual and graphical information recorded during its design, development, and maintenance regarding its capabilities, development history, theoretical foundation, operation, and verification. It is the principal instrument for those involved in its development and use, such as code development and maintenance staff, network managers, code users, and project managers, to communicate regarding all aspects of the software.

1.2 This guide presents the major steps in preparing the documentation of a ground-water modeling code. It discusses the various documentation audiences and addresses the role of printed documentation versus documentation in electronic form.

1.3 This guide is one of a series of guides on ground-water modeling codes and their applications, such as Guides D 5447, D 5490, D 5609, D 5610, D 5611, and D 5718.

1.4 This guide is not intended to be all inclusive. If offers a series of options and considerations, but does not specify a course of action. Documenting certain codes may require supplemental information or replacement of documentation sections by more appropriate elements. This guide should not be used as a sole criterion or basis of comparison, and does not replace or relieve professional judgement in preparing or evaluating documentation of ground-water modeling software.

1.5 This standard does not purport to address all of the safety concerns, if any, associated with its use. It is the responsibility of the user of this standard to establish appropriate safety and health practices and determine the applicability of regulatory limitations prior to its use.

1.6 This guide offers an organized collection of information or a series of options and does not recommend a specific course of action. This guide cannot replace education or experience and should be used in conjunction with professional judgment. Not all aspects of this guide may be applicable in all circumstances. This guide is not intended to represent or replace the standard of care by which the adequacy of a given professional service must be judged, nor should this guide be applied without consideration of a project's many unique aspects. The word 'Standard' in the title of this document means only that the document has been approved through the ASTM consensus process.

2. Referenced Documents (purchase separately) The documents listed below are referenced within the subject standard but are not provided as part of the standard.

ASTM Standards

D653 Terminology Relating to Soil, Rock, and Contained Fluids

D5447 Guide for Application of a Ground-Water Flow Model to a Site-Specific Problem

D5490 Guide for Comparing Ground-Water Flow Model Simulations to Site-Specific Information

D5609 Guide for Defining Boundary Conditions in Ground-Water Flow Modeling

D5610 Guide for Defining Initial Conditions in Ground-Water Flow Modeling

D5611 Guide for Conducting a Sensitivity Analysis for a Ground-Water Flow Model Application

D5718 Guide for Documenting a Ground-Water Flow Model Application

Keywords

computer code; documentation; groundwater modeling: Code development; Computer model; Documents/documentation--water applications; Field investigations; Ground-water model; Software--groundwater analysis applications;

ICS Code

ICS Number Code 13.060.10 (Water of natural resources); 35.080 (Software)

DOI: 10.1520/D6171-97R04

ASTM International is a member of CrossRef.