# Example applications

This section of the documentation covers example usage of digger. It includes usage of [`digger.make`](#digger.make) functions that are typically used before a simulation and usage of [`digger.analyze`](#digger.analyze) and [`digger.compare`](#digger.compare) functions that are typically used after a simulation has completed.

The text presented here surrounds code that is located within `digger/examples/pre-run/<example-name>` and `digger/examples/post-run/<example-name>`. The pre-run examples may be run on a user's computer directly. These examples rely on files within the `digger/data` directory. The post-run examples require D-Claw output in order to complete successfully. Instructions on how to run the examples are given in the [run](run/index.md) section. Alternatively, the necessary output is located in a zipped file within the `digger/data` directory.

It is suggested that a user work through tutorial applications in the order listed below.  


```{toctree}
---
caption: Organization of examples
maxdepth: 3
---
make/index.md
run/index.md
analyze/index.md
compare/index.md
```


:::{note}
digger is scientific software. A user should expect to gain a high-level understanding of what is being done by each function using the documentation, including these examples. For detailed understanding, a user should expect to read the source code of the functions they are using.
:::

:::{warning}
digger was designed to make it easier to run D-Claw, a model based on the [clawpack package](https://www.clawpack.org/). This documentation presumes knowledge of how D-Claw and clawpack applications are specified. Where most relevant, links to clawpack documentation are provided. Without knowledge of clawpack application specification and file formats, some aspects of digger may be confusing.
:::

:::{attention}
The diagnostic figures generated by digger are not intended as publication quality.
:::