Documentation update planning
Opened this issue · 0 comments
bch0w commented
Documentation has fallen behind code and will require updates, as well as improved documentation and FAQs etc. Using this Issue as a tracking page to plan out what documentation is needed and what takes priority.
Closing old docs issue #121 and replacing with this for better visibility.
Planned Documentation
- How to set up directory structure/file naming for observed waveform data
- Decision tree for how to troubleshoot common job failures
- How to use the sfstate checkpointing system to rerun tasks
- How to write your own System subclass
- Create a Frequently Asked Questions (FAQ) from Issues
- How to use Debug mode for manual control flow
- SPECFEM3D homogeneous halfspace example problem and walkthrough
More to come...