 # Examples

Example input files and post-processing scripts can be found in two places:  
 * ```examples/``` folder in the main repository provide example problems that are good starting points or "cookbooks" for more complex models.
 * [AxiSEM3D Example Gallery](https://github.com/AxiSEMunity/AxiSEM3D_example_gallery) is a repository for published models.

 ## Contributing examples
 AxiSEM3D has a number of examples that illustrate how to use certain features of the code. If you have a model setup that illustrates a feature or a certain type of model, please share! We are happy to add new examples to help AxiSEM3D community.

 1. Create a new folder inside the ```examples/``` folder following the established naming scheme.  Use a short descriptive name to identify its contents.
 2. All input files should be included in an ```input/``` folder in your new folder.
 3. Create a ```README.md``` file. Include a description of the cookbook. The description can include methods, proper (or improper) uses, figures, proper citation (bibtex preferred), etc. This ```README.md``` is included in the documentation.
 4. Other files.  Include .ipynb for post processing and helpful .sh scripts if needed.

## Table of Contents

```{toctree}
---
maxdepth: 1
---
examples/00_global_1D/README.md
examples/01_S362ANI_EMC_global/README.md
examples/02_3d_crust_S362ANI_regional/README.md
examples/03_salt_body_SEG_local/README.md
examples/04_simple_3d_shapes/README.md
examples/05_anisotropy_global/README.md
examples/06_finite_source_local/README.md
examples/07_atmosphere_Mars_global/README.md
examples/08_icesheet_regional/README.md
examples/09_wave_visualization_Moon/README.md
```

