Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation update planning #198

Open
7 tasks
bch0w opened this issue Mar 4, 2024 · 0 comments
Open
7 tasks

Documentation update planning #198

bch0w opened this issue Mar 4, 2024 · 0 comments
Labels
enhancement in progress

Comments

@bch0w
Copy link
Member

bch0w commented Mar 4, 2024 •
edited
Loading

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...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement in progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bch0w