A review of the ISSM adapter using the contributing guidelines. This is a work-in-progress that will eventually be moved.

The ISSM adapter conforms to most of the preCICE best practices.

Metadata:

  • M.1: ISSM
  • M.2: https://git.rwth-aachen.de/terrabyte-dnn2sim/issm-precice
  • M.3: BSD-3-Clause
  • M.4: Daniel Abele <daniel.abele dlr.de>, Angelika Humbert <angelika.humbert awi.de>
  • M.5: https://doi.org/10.5194/egusphere-2025-3345
  • M.6: stand-alone

Required best practices:

  • R.1: Two application cases are available at https://doi.org/10.5281/zenodo.15849145. The cases do not follow the guidelines for application cases, mainly file/directory structure and naming conventions. Additionally, the input data for ISSM is in binary form and only compatible with ISSM version 4.24.
  • R.2: README.md
  • R.3: LICENSE
  • R.4: GitLab project
  • R.5: The project uses semantic versioning.
  • R.6: CHANGELOG.md
  • R.7: issue tracker on GitLab
  • R.8: .clang-format
  • R.9: Error handling is inconsistent. Many errors are checked and caught, but messages are often generic and not helpful.
  • R.10: The adapter config conforms to the recommended schema, limitations are documented in (docs). Loading from default location is currently not supported.
  • R.11: The adapter uses the same vertices in 2D or 3D space as ISSM itself.
  • R.12: Flux directions are currently not considered.

Additional criteria:

  • A.1: BSD-3-clause
  • A.2: repository is publicly accessible
  • A.3: Documentation is only available as markdown on GitLab
  • A.4: Console output is configurable at run-time, but cannot be turned off entirely. The options are errors\warnings, verbose and trace
  • A.5: A paper is in peer-review with limited validation for real life use.
  • A.6: CONTRIBUTING.md
  • A.7: Pull request template not available.
  • A.8: No documentation specifically for extending the adapter.
  • A.9: Coverage of the unit test suite is reported in the GitLab project. Input data for a small number of unit tests is currently not publicly available.
  • A.10: The adapter is not integrated into the preCICE system tests.
  • A.11: The adapter is not packaged, since ISSM itself is also not packaged.