PrincetonUniversity / SPECFEMPP

SPECFEM++ is a complete re-write of SPECFEM suite of packages (SPECFEM2D, SPECFEM3D, SPECFEM3D_GLOBE) using C++

https://specfem2d-kokkos.readthedocs.io/en/latest/

GNU General Public License v3.0

16 stars 9 forks source link

Domain documentation update #91

Closed Rohit-Kakodkar closed 11 months ago

Rohit-Kakodkar commented 11 months ago

Description

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

Reorganized API documentation to use doxygenclass over doxygenfile - this improves readability and flexibilty in the the new docuementation
Added SPECFEM architecture documentation
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.

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