PyPartMC icon indicating copy to clipboard operation
PyPartMC copied to clipboard

Published 20 hours ago • verified publisher icon open-atmos

enhance CONTRIBUTING.md file

Open slayoo opened this issue 10 months ago • 0 comments

  • [ ] explain how to run the tests
  • [ ] explain how to add new tests
  • [ ] explain why in the C++ code we use static methods manually taking a reference to self
  • [ ] explain why it is OK to have compiled-in symbols for libs such as hdf5, SUNDIALS, and why it does not conflict with these symbols being used from other libs like SciPy (see also https://github.com/open-atmos/PyPartMC/issues/16)
  • [ ] explain how to contribute to the documentation at the API docstring level (+ how it relates to PartMC Doxygen strings and how it is used by pdoc)

slayoo avatar Feb 03 '25 11:02 slayoo