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

Issue 506 - Addressing comments on previous few commits #510

Open
wants to merge 43 commits into
base: issue-390
Choose a base branch
from

Conversation

lsawade
Copy link
Collaborator

@lsawade lsawade commented Feb 25, 2025

Description

Cosmetic changes to both code and documentation. See #506 for a full list of tasks/adjustments

  • Creates documentation for most Meshfem3D structs
  • Creates documentation for read_array utilities and cleans up template.
  • Updates print functions
  • New feature for documentation building that severely reduces build time when editing the .rst files. Until now doxygen is always run whenever you build the documentation. This should be the standard behavior. But when you are just editing the RST files and not the actual source files it causes the source xmls to be rebuilt every single time. And sphinx needs to reread the files even though nothing has changed. you can now set
    export NODOXYGEN=1
    and sphinx will check whether you want to actually rebuild the doxygen folder as well. This is not perfect, a better implementation would be through make. But I am no make wizard.
  • fixes a kokkos::parallel_reduce loop to find min/max kappa and mu to run on host executionspace.

Issue Number

closes #506

Checklist

Please make sure to check developer documentation on specfem docs.

  • I ran the code through pre-commit to check style
  • My code passes all the integration tests
  • I have added sufficient unittests to test my changes
  • I have added/updated documentation for the changes I am proposing
  • I have updated CMakeLists to ensure my code builds
  • My code builds across all platforms

icui and others added 30 commits February 7, 2025 16:46
Add function to access field of a medium
…ed buuild/html added, added doc strings and examples to fortran/IO and mesh/dim3 reading utilities with examples
Copy link
Collaborator

@Rohit-Kakodkar Rohit-Kakodkar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@lsawade
Copy link
Collaborator Author

lsawade commented Feb 26, 2025

Final commit fixed the NVIDIA compiler bug highlighted in #476

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.

4 participants