PROJECT TITLE

Replace this text with a short guide for someone new to the project.
Keep the instructions concrete and test them from a clean working folder.

PURPOSE
Physical question and intended use:
Main quantities calculated:
Author(s) / contact:

MODEL AND METHOD
Equations and main physical assumptions:
Variables, units, coordinate/sign conventions:
Initial and boundary conditions:
Numerical method and relevant references:

FILES
Source code:
Input data and example inputs:
Output data:
Plotting/analysis files:
Run records:

REQUIRED SOFTWARE
Language/compiler/interpreter and tested versions:
Libraries or packages and any additional access requirements:
Build or installation steps, if needed:

RUNNING THE EXAMPLE
Working directory:
Exact command(s) or interactive steps:
Input file and parameter values:
Expected output filenames, columns, and units:
Representative result and an appropriate comparison tolerance:
Approximate run time, if useful:

CHECKING AND REPRODUCING RESULTS
How to repeat the example:
Verification tests and expected outcomes:
Physical validation comparisons and their scope:
How to identify the code version and inputs for a saved result:
Random-number and parallel-execution settings, if relevant:

LIMITATIONS
Supported parameter range and known numerical limitations:
Physical assumptions that restrict interpretation:
Known problems and unresolved checks: