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

Domain documentation update #91

Merged

Conversation

Rohit-Kakodkar
Copy link
Collaborator

@Rohit-Kakodkar Rohit-Kakodkar commented Oct 23, 2023

Description

Updates documentation for domain optimization. I've made several major changes on how domain is organized using sphinx.

  1. Reorganized API documentation to use doxygenclass over doxygenfile - this improves readability and flexibilty in the the new docuementation
  2. Added SPECFEM architecture documentation
  3. Current change updates the name from SPECFEM Kokkos to SPECFEM++

Issue Number

If there is an issue created for these changes, link it here

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

@Rohit-Kakodkar Rohit-Kakodkar merged commit 238111b into domain-performance-optimization Oct 23, 2023
2 checks passed
@Rohit-Kakodkar Rohit-Kakodkar deleted the domain-documentation-update branch November 12, 2024 18:27
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.

1 participant