Difference between revisions of "SCEC Software"
From SCECpedia
Jump to navigationJump to search| Line 8: | Line 8: | ||
# A public SCECpedia entry that provides and overview of the software project, the capabilities of the software, and a software release history. | # A public SCECpedia entry that provides and overview of the software project, the capabilities of the software, and a software release history. | ||
| − | |||
# A private SCECpedia entry that describes the software development information for the project including design overview, data sources, algorithms used, software language, development environment, run-time environment, and required software stack. | # A private SCECpedia entry that describes the software development information for the project including design overview, data sources, algorithms used, software language, development environment, run-time environment, and required software stack. | ||
| − | |||
# Source code under version control. | # Source code under version control. | ||
| − | |||
# Issue tracking system (TRAC) site with a trouble ticket system and a connection to source code under version control. | # Issue tracking system (TRAC) site with a trouble ticket system and a connection to source code under version control. | ||
| − | |||
# Automated suite of user-oriented acceptance tests typically-based on reference inputs and outputs compared to calculated results. | # Automated suite of user-oriented acceptance tests typically-based on reference inputs and outputs compared to calculated results. | ||
| − | |||
# Automated build and test capability, such as CruiseControl, which will run the acceptance tests without manual interactions. | # Automated build and test capability, such as CruiseControl, which will run the acceptance tests without manual interactions. | ||
| − | |||
# Assigned Software Version Number using CSEP model of Yr.Mo.Day v10.8.1 with tags in version control system. | # Assigned Software Version Number using CSEP model of Yr.Mo.Day v10.8.1 with tags in version control system. | ||
| − | |||
# Release Description wiki pages containing the following information: | # Release Description wiki pages containing the following information: | ||
| − | + | ##Software or system name and description of purpose of software | |
| − | + | ##Link to public web page describing project | |
| − | + | ##Description of software capabilities | |
| − | + | ##Description of intended users | |
| − | + | ##Version of current release | |
| − | + | ##Overview of changes including new capabilities of current release | |
| − | + | ##Software support email list | |
| − | + | ##Contact for Responsible scientists | |
| − | + | ##Contact for Responsible Software Engineer | |
| − | + | ##How to report software problem or request features | |
| − | |||
# User documentation including web and pdf versions of: | # User documentation including web and pdf versions of: | ||
| − | + | ## Scientific User Guide to using Software and results | |
| − | + | ## Computer User Guide to Installing and operation software | |
Revision as of 14:18, 27 July 2010
SCEC Software Release Policies
SCEC software engineering group has established standard practices for use when releasing new versions of publicly distributed scientific software. These practices are based on "best practices" for scientific software development established on SCEC's CSEP project and on SCEC's UseIT SCEC-VDO project.
Every SCEC/CME project that releases SCEC-developed and SCEC-supported software to the community is expected to provide the following materials before the software is released, unless there is a good reason not to follow these guidelines.
Before SCEC/CME software development group releases Each software project must have the following items:
- A public SCECpedia entry that provides and overview of the software project, the capabilities of the software, and a software release history.
- A private SCECpedia entry that describes the software development information for the project including design overview, data sources, algorithms used, software language, development environment, run-time environment, and required software stack.
- Source code under version control.
- Issue tracking system (TRAC) site with a trouble ticket system and a connection to source code under version control.
- Automated suite of user-oriented acceptance tests typically-based on reference inputs and outputs compared to calculated results.
- Automated build and test capability, such as CruiseControl, which will run the acceptance tests without manual interactions.
- Assigned Software Version Number using CSEP model of Yr.Mo.Day v10.8.1 with tags in version control system.
- Release Description wiki pages containing the following information:
- Software or system name and description of purpose of software
- Link to public web page describing project
- Description of software capabilities
- Description of intended users
- Version of current release
- Overview of changes including new capabilities of current release
- Software support email list
- Contact for Responsible scientists
- Contact for Responsible Software Engineer
- How to report software problem or request features
- User documentation including web and pdf versions of:
- Scientific User Guide to using Software and results
- Computer User Guide to Installing and operation software
