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.

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

Complete documentation with example problems, FAQs, etc. #121

Closed
5 tasks
bch0w opened this issue May 31, 2022 · 3 comments
Closed
5 tasks

Complete documentation with example problems, FAQs, etc. #121

bch0w opened this issue May 31, 2022 · 3 comments

Comments

@bch0w
Copy link
Member

bch0w commented May 31, 2022

The documentation page (https://seisflows.readthedocs.io/en/latest/index.html) is currently a direct port from the previous SeisFlows3 documentation, which was in a developmental state. Documentation pages which should be added to consider the next docs version "complete" include:

  • Update documentation to remove old references of SeisFlows3 and SF3
  • SPECFEM3D example problem and walkthrough
  • How-To extend SeisFlows yourself (i.e., writing your own super class)
  • Frequently Asked Questions (FAQ)
  • Debugging SeisFlows
@bch0w bch0w changed the title Complete documentation with example problems and FAQs Complete documentation with example problems, FAQs, etc. May 31, 2022
@bch0w bch0w added this to the SeisFlows v2.1.0 milestone May 31, 2022
@bch0w
Copy link
Member Author

bch0w commented Oct 12, 2022

See SPECFEM Users Workshop material (announced in #136) for a plethora of workshop material which explains a lot of the underlying structure of SeisFlows.

In particular the Day 3C notebook gives an introduction to SeisFlows.

@bch0w
Copy link
Member Author

bch0w commented Mar 2, 2023

Documentation greatly improved in #146 and #147

@bch0w
Copy link
Member Author

bch0w commented Mar 4, 2024

Closing in favor of new issue #198

@bch0w bch0w closed this as completed Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant