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

Examples: subduction 3d #363

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

cmills1095
Copy link
Contributor

Notes:

Too much for one pull request? The different sections are each in their own commit, hope that helps. Better to do a pull request for each file? Tell me about how you'd like to organize these

index.md: Not yet sure how to manually recreate some of that table's features in this format. The table is found in doc under 3d_subduction_features.tex. Cheap but practical way might be to export userguide pdf as image and then crop out table and load it as an image instead of table?

meshing.md: Sentence that starts with "We provide journal files for both a mesh with..." seems like it should be talking about two different files about references the same one twice, mesh_tet.jou. Typo?

step07: link to sec:example:greensfns2d. Note sure exactly what that's referring to as it appears as ?? in the pdf userguide.

@baagaard-usgs
Copy link
Contributor

Too much for one pull request? The different sections are each in their own commit, hope that helps. Better to do a pull request for each file? Tell me about how you'd like to organize these

I think this approach is quite good.

index.md: Not yet sure how to manually recreate some of that table's features in this format. The table is found in doc under 3d_subduction_features.tex. Cheap but practical way might be to export userguide pdf as image and then crop out table and load it as an image instead of table?

We now embed the list of features in the .cfg files. I have a Python script that allows a user to search for features. I am going to write a similar script to extract the list of features for each step and write them as a table in a Markdown file so that we can just include the file. This is why I am having you just put in TODO admonitions for the list of features tables.

@baagaard-usgs
Copy link
Contributor

baagaard-usgs commented Oct 28, 2021

@cmills1095 I am working on this PR. I had updated the files for this example for the current version of the code but not the manual. Consequently, I am going to make a PR to your branch with fixes that update the documentation to match the example files.

Note: Please name your branches to match the specific item you are working on. For example: docs-examples-3d-subduction. Don't worry about renaming the branch for this PR.

Brad's TODO

  • Finish updating documentation for Step 8.
  • Update the example files for Steps 6 and 7.
  • Update documentation for Step 6.
  • Update documentation for Step 7.
  • Pull in updates from baagaard/update-examples-3dsubduction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants