Skip to content Skip to navigation

Software & Services Registration

Registration Steps


For an introduction see Getting Started below.

  1. Login to the CSR

  2. Register (if needed) a Support Organization for your component

  3. Register (if needed) a hosting Resource or Science Gateway

  4. Register (if needed) a Global Software and Service component

  5. Register Packaged Software and Operational Software and Services

     

Getting Started


The Community Software Repository (CSR) enables research cyberinfrastructure (CI) users to discover operational software on XSEDE resources, campus resources, thru science gateways, and from other infrastructure operators. The CSR also enables CI operators and developers to discover packaged software they can install for their users, or for their own use.

From these pages software providers (developers, integrators, and operators) can manually register the software they make available to software users and consumers. For providers that have software catalogs and want to automatically register from those catalogs instead of manually, XSEDE provides the Information Publishing Framework (IPF) software. New software providers can e-mailing help@xsede.org and request "CSR Software Registration Access".

The CSR contains information about:

  • Packaged Software which must be provisioned or installed before it can be used, and may be distributed in any form, including source tar, vendor package, build recipes, VM image, container, etc.
  • Operational Software and Services which are ready-to-use, and are typically accessed from the command line, thru an execution environment, or as a remote network service.

So that users can discovery all forms of both packaged and operational software the CSR includes a Global Software and Services index where the global attributes of software, such as vendor, description, and tags/categories are recorded. Packaged Software and Operational Software and Services may reference a Global Software and Service item to enable discovery of all forms of a component. 

Support Organization information describes how to contact packaged or operational software support.

Before registering a new packaged or operational component please do the following:

  1. Identify the component Support Organization and make sure it is registered.
  2. Identify the hosting cluster Resource or Science Gateway and make sure it is registered.
  3. If linking multiple forms of the same component is useful, identify the Global Software and Service component and make sure it is registered.

Registering Packaged Software

Guidelines for registering Packaged Software:

  • Package Name: the short user facing case sensitive common package name

  • Version: the software version, or the word "Latest" if you are providing pointers that will always reference the latest version of the software
  • Global Component: select a Global Component if available and useful for linking all forms of the same component 
  • Support Contact: select the package support organization (this organization may support the package and forward software issues to the provider)

Register Operational Software and Services

Guidelines for registering Operational Software and Services:

  • Name: the short user facing case sensitive common name

  • Version: the software version, or the word "Latest" if you are providing pointers that will always reference the latest version of the software, or "NA" is this is for a hosted SaaS that is constantly changing.
  • Global Component: select a Global Component if available and useful for linking all forms of the same component 
  • Support Contact: select the component support organization (this organization may not support the software itself, but is responsible for dealing with support issues)
  • Hosting Resource: the hosting HPC, HTC, Storage, Viz, Cloud, or Gateway
  • Science Gateway: the Gateway that is hosting and providing access to this component
  • Type: select Network Service if users access this component thru the network, or Execution Environment if users access this component from the command line or thru file-system paths in an execution environment
  • Network Service Endpoint(s): enter the endpoint URI in standard <protocol>:<path> format
  • Execution Handle: enter the execution environment URI in the form "module:<module_name>" or "path:<path>"

Support OrganizationsOperational Software and ServicesPackaged SoftwareGlobal Software and Services