Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 2.14 KB

File metadata and controls

48 lines (38 loc) · 2.14 KB

Summary

PR Checklist

  • If this is a work in progress PR, set as a Draft PR
  • General
    • Notebook is compatible with latest SimPEG release
    • No deprecated functions and/or input arguments are being used
    • Coding cells linted according to the style guides.
  • Introduction is complete:
    • Title and author added to notebook
    • Admonitions for notebook difficulty and computational resources have been added
    • Keywords list has been added
    • Summary paragraph describing the tutorial has been added
    • Learning objectives have been listed
    • Hyperlinks to other tutorial notebooks added if necessary
  • For sections and subsections:
    • A header and short summary of what is being done
    • Links to API documentation added for all classes and functions that are used
    • Newly introduced functionality is explained, or links are provided to relevant materials
    • The approach taken when choosing hyperparameter values is explained. The use of ad hoc values without explanation is discouraged
    • All figures are legible and rendered appropriately
  • Marked as ready for review (if this is was a draft PR), and converted to a pull request
  • Tagged @simpeg/simpeg-developers when ready for review

Additional information