CSDMS Best Practices for Software Development: Difference between revisions
From CSDMS
(Start document) |
m (Add Python suggestions from SaltStack.com; minor phrasing changes) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{PageTitle| | {{PageTitle|Best Practices for Software Development}} | ||
In the CSDMS Integration Facility, | In the CSDMS Integration Facility, | ||
we've been talking for a few years about creating a "best practices" document | we've been talking for a few years about creating a "best practices" document | ||
for the | for the community | ||
that would help members | that would help members | ||
develop and maintain model code, | develop and maintain model code, | ||
| Line 10: | Line 10: | ||
Let this be a start. | Let this be a start. | ||
Here are | Here are a few references, proposed by Scott Stewart, that may be of interest: | ||
* NOAA's operational code standards: http://projects.osd.noaa.gov/SPSRB/standards_software_coding.htm | * NOAA's operational code standards: http://projects.osd.noaa.gov/SPSRB/standards_software_coding.htm | ||
* NCAR working group: http://www.cesm.ucar.edu/working_groups/Software/dev_guide/dev_guide/dev_guide.html | * NCAR working group: http://www.cesm.ucar.edu/working_groups/Software/dev_guide/dev_guide/dev_guide.html | ||
* Python-specific suggestions used at [https://saltstack.com/about/ SaltStack]: https://docs.saltstack.com/en/latest/topics/development/conventions/style.html | |||
Latest revision as of 20:47, 5 June 2017
Best Practices for Software Development
In the CSDMS Integration Facility, we've been talking for a few years about creating a "best practices" document for the community that would help members develop and maintain model code, and also provide practical advice on how to implement a BMI.
Let this be a start.
Here are a few references, proposed by Scott Stewart, that may be of interest:
- NOAA's operational code standards: http://projects.osd.noaa.gov/SPSRB/standards_software_coding.htm
- NCAR working group: http://www.cesm.ucar.edu/working_groups/Software/dev_guide/dev_guide/dev_guide.html
- Python-specific suggestions used at SaltStack: https://docs.saltstack.com/en/latest/topics/development/conventions/style.html
