Library

From HP-SEE Wiki

Contents 1 Authors/Maintainers 2 Summary 3 Features 4 Architectural/Functional Overview 5 Usage Overview 6 Dependencies 7 HP-SEE Applications 8 Resource Centers 9 Usage by Other Projects and Communities 10 Recommendations for Configuration and Usage

• Web site: link
• Described version: xx.xx
• Licensing: e.g. LGPL 3, BSD...
• User documentation: link
• Download: link
• Source code: link

Authors/Maintainers

• Also origin, if the software comes from a specific project.

Summary

One paragraph description of purpose, targer area, approach.

Features

• Listed features

Architectural/Functional Overview

• high level design info, how it works, performance - may be a link, or several links

Usage Overview

• If possible with small example - may be a link

Dependencies

• list of all relevant dependencies on other libraries

HP-SEE Applications

• Applications using it

Resource Centers

• RCs supporting it (with version number if not the same as above)

Usage by Other Projects and Communities

• If any

Recommendations for Configuration and Usage

Please describe here any common settings, configurations or conventions that would make the usage of this resource (library or tool) more interoperable or scalable across the HP-SEE resources. These recommendations should include anything that is related to the resource and is agreed upon by administrators and users, or across sites and applications. These recommendations should emerge from questions or discussions opened by site administrators or application developers, at any stage, including installation, development, usage, or adaptation for another HPC centre.

Provided descriptions should describe general or site specific aspects of resource installation, configuration and usage, or describe the guidelines or convention for deploying or using the resource within the local (user/site) or temporary environment (job). Examples are:

• Common configuration settings of execution environment
• Filesystem path or local access string
• Environment variables to be set or used by applications
• Options (e.g. additional modules) that are needed or required by applications and should be present
• Minimum quantitative values (e.g. quotas) offered by the site
• Location and format of some configuration or usage hint instructing applications on proper use of the resource or site specific policy
• Key installation or configuration settings that should be set to a common value, or locally tweaked by local site admins
• Conventions for application or job bound installation and usage of the resource