Difference between revisions of "Software Documentation"
(Created page with 'SCEC software engineering group distributes numerous scientific software codes to the research community. These software codes are accompanied by documentation to explain how to …') |
|||
Line 3: | Line 3: | ||
== Overview == | == Overview == | ||
− | [[CME Project]] software developers integrate complex scientific codes together into larger computational systems that we call [[Computational Platforms]]. These computational platform provide valuable research tools to the scientific community. To ensure these end user can make full use of the platforms capabilities, necessary software documentation is provided with these platforms. The two key forms of documentation SCEC strives to provide are detailed 'User Guides' and web-based 'Wiki' pages. | + | [[CME Project]] software developers integrate complex scientific codes together into larger computational systems that we call [[Computational Platforms]]. These computational platform provide valuable research tools to the scientific community. To ensure these end user can make full use of the platforms capabilities, necessary software documentation is provided with these platforms. The two key forms of documentation SCEC strives to provide are detailed 'User Guides' and web-based project 'Wiki' pages. |
== Types of Documentation == | == Types of Documentation == |
Revision as of 00:00, 18 February 2011
SCEC software engineering group distributes numerous scientific software codes to the research community. These software codes are accompanied by documentation to explain how to use these codes effectively.
Overview
CME Project software developers integrate complex scientific codes together into larger computational systems that we call Computational Platforms. These computational platform provide valuable research tools to the scientific community. To ensure these end user can make full use of the platforms capabilities, necessary software documentation is provided with these platforms. The two key forms of documentation SCEC strives to provide are detailed 'User Guides' and web-based project 'Wiki' pages.
Types of Documentation
Wiki Pages
Web based Wiki pages.
User Guides
User guides distributed with software platforms.