Skip to content

🌟 Feature request: Write examples for the effective media modelling code #2

@hemmelig

Description

@hemmelig

Feature request

Summary:

Write examples (and tests!) for the effective media modelling code


Is your feature request related to a problem? Please describe.
No - simply an extension.

Describe the solution you'd like
A set of comprehensive examples that contain code snippets and an overview of the theory such that users can get started straight away building their own effective media models. I can provide some examples based on what I have used these models for.

Comprehensive tests should also be written that explore the functions in anisotropy.effective_media. Start by validating code against alternatives (e.g. MSAT), then produce a set of benchmarks with the code itself.

To-do list

  • Write test suite
    • Hudson models
    • Backus layering models
    • Tandon and Weng models
    • N-layer models of Silver and Savage
  • Write examples for documentation
    • Hudson model
    • Backus model - use example from Omry?
    • Tandon and Weng model - use example from Chapter 5 of my thesis.
    • N-layer model - use example data from northern Borneo

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is needed

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions