xSDK compatibility

[phlptp]

For better compatibility with HPC systems and smoother interaction with other scientific software this might not be a bad goal to aspire to.

xSDK compatibility

I don't think we are that far off but there are definitely a few things we don't meet yet.
I think compatibility might be a goal for HELICS 3.0. and some discussion might be warranted on whether we pursue this officially or unofficially.

TODO XSDK compatibility checklist

• [x] M1 Support installation through Spack
• [x] M2 test suite
• [ ] M3 no direct use of MPI_COMM_WORLD
• [x] M4 Portability
• [x] M5 Reliable contact information
• [x] M6 Respect system resources & settings
• [x] M7 Permissible license
• [x] M8 Full version info available at runtime
  • [x] runtime configuration options listing
  • [x] run time version and build info for dev builds
• [x] M9 use proper namespacing
• [x] M10 Use version control
• [ ] M11 No hard wired print
  • [ ] option to turn off all printing
  • [x] all logging to a single thread
• [ ] M12 external dependencies must be replaceable
• [x] M13 Honor install prefix
• [x] M14 64 bit pointers by default
• [x] M15 Compatibility is sustainable
• [x] M16 Configuration option to build in Debug mode
  • [x] Spack variant to enable Debug mode (build_type)

Recommended

• [x] R1 Public source code
• [x] R2 Use Debugging tools, valgrind, etc
• [ ] R3 Error reporting is consistent
• [x] R4 Release system resources as soon as possible
• [ ] R5 Export an ordered list of dependencies
• [ ] R6 Document versions of dependencies
• [x] R7 Common repository files
  • [x] Readme
  • [x] LICENSE
  • [x] SUPPORT.md
  • [x] CHANGELOG.md
• [ ] R8 Sufficient documentation to support use and further development
  • [ ] Instructions on installation and getting started
  • [ ] Documentation on functionality (class/member/API-level documentation)
  • [ ] How individual components interact (ideally using "typical use case" code snippets)
  • [ ] Complete example codes that illustrate typical use cases
  • [ ] Links to external resources for users and developers to find help
  • [ ] Instructions for on-ramping new developers
  • [ ] Description of team processes

[phlptp]

For anyone interested here is a webinar on the topic

https://www.exascaleproject.org/event/software-policies/

[phlptp]

TODO XSDK compatibility checklist

• [ ] M1 Required CMAKE options
  • [ ] USE_XSDK_DEFAULTS
  • [ ] XSDK_ENABLE_<language>
  • [ ] Machine readable provenance
• [x] M2 test suite
• [ ] M3 no direct use of MPI_COMM_WORLD
• [x] M4 Portability
• [x] M5 Reliable contact information
• [x] M6 Respect system resources & settings
• [x] M7 Permissible license
• [ ] M8 Full version info available at runtime
  • [ ] runtime configuration options listing
  • [x] run time version and build info for dev builds
• [x] M9 use proper namespacing
• [x] M10 Use version control
• [ ] M11 No hard wired print
  • [ ] option to turn off all printing
  • [x] all logging to a single thread
• [ ] M12 external dependencies must be replaceable
• [x] M13 Honor install prefix
• [ ] M14 64 bit pointers by default
• [x] M15 Compatibility is sustainable
• [ ] M16 production quality installation process
  • [ ] Spack

Recommended

• [x] R1 Public source code
• [x] R2 Use Debugging tools, valgrind, etc
• [ ] R3 Error reporting is consistent
• [x] R4 Release system resources as soon as possible
• [ ] R5 Export an ordered list of dependencies
• [ ] R6 Document versions of dependencies
• [x] R7 Common repository files
  • [x] Readme
  • [x] LICENSE
  • [x] SUPPORT.md
  • [x] CHANGELOG.md

[nightlark]

I think we meet no direct use of MPI_COMM_WORLD, we either use the a user provided communicator or a duplicate of MPI_COMM_WORLD as a default. There's other parts of M3 that should be done better, like feature detection and error handling.