Examples

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 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#