x STIP Home Page         People and Working Groups         STIP Archive
Task Force to Transition Software into the Decentralized Electronic STI Environment

Description - This Task Force will revise Part III of the DOE G 241.1-1 to reflect the transition of the Department’s software to the decentralized electronic STI environment.

Objective - The objective is to revise Part III of the DOE G 241.1-1 to reflect changes such as; managing software in a manner similar to report literature (e.g., site submission of metadata records for inclusion in the DOE Information Bridge), blend OSTI’s ESTSC and Request Services staff and functions, and work toward decentralized management of STI software where sites host software and OSTI simply links to it (e.g., for "freeware").

Deliverable - The first deliverable is a draft revision of Part III which was posted on the STIP Home Page in April 1999 for initial comment from the STIP community. Following the initial comment period ending May 18, 1999, the final draft will be submitted to the formal directives process. The task force will make necessary revisions based on the formal directives process. The effective date for implementing the revised Part III of the Guide is January 2000.

Duration - This Task Force is being transitioned from the STIP Goal 3 Team who began working on the task in December 1998. The targeted completion date for the task deliverable to be completed is September 1999.

Team Leader - The leader for this Task Force is Cindy Crego, Fermilab

Facilitator - The Task Force facilitator is Sharon Jordan, OSTI

Part III Guide Revision Subteam 

Part III, "Processing Software for Announcement . . ." 9th DRAFT


The existing Attachments 11, 12, 13, 14, 15, 16, and 17 will be replaced by a new Attachment 11 and Attachment 12.

 Part III. DOE Scientific and Technical Software

1.0 Introduction
1.1 Departmental Requirements
1.2 Electronic Software Management
2.0 Responsibilities
2.1 OSTI
2.2 Specialized Information Analysis Centers (SIACs)
2.3 Software Originators/Creators
3.0 Software Announcement and Submission
3.1 STI Software Appropriate for Announcement
3.2 Announcement/Submission Criteria
3.3 Software Categories
3.4 Announcement Record (Metadata)
4.0 Software Access
4.1 Distribution of Software
4.2 Software Dissemination to Foreign Countries
4.3 Licensing of Software

 

1.0 Introduction

Software management is currently transitioning from a centralized collection, announcement and dissemination activity to a decentralized activity. During this transition, paper-based submission guidelines will be replaced with electronic submission guidelines for certain categories of software. New guidelines will also allow for distributed hosting and dissemination of certain categories of software.

A Scientific and Technical Information Program (STIP) work group was established during calendar year 1998 to develop the procedures necessary to transition scientific and technical computer software management to a decentralized environment. This part of the guide was revised to reflect the new procedures and will continue to be reviewed and changed, as new decentralized procedures are adopted. Procedures for announcing software and submitting software for dissemination are detailed in the following sections. The manner for distributing software is defined through the announcement and submission procedures.

1.1 Departmental Requirements

DOE O 241.1 requires that scientific and technical information (STI) (including scientific and technical computer software) be made broadly available, within applicable laws and Departmental requirements, to accomplish mission objectives and strategic goals, promote scientific advancement, satisfy statutory protection and public dissemination requirements, and ensure a fair return on Departmental and taxpayer investment. Specifically, DOE O 241.1 requires that useful STI products, including software, resulting from scientific and technical endeavors be made available and announced to the Office of Scientific and Technical Information (OSTI) - in order for OSTI to fulfill appropriate announcement, dissemination, and exchange responsibilities on behalf of the Department.

1.2 Electronic Software Management

The Department's STI Program has been undergoing a transition to a decentralized, electronic STI management environment. Steps to decentralize the STI products other than software were put into place in October 1998. Software management is making a similar transition, effective January 2000, with the procedures necessary to transition scientific and technical computer software described herein.

The objectives for decentralizing software management are to:

  • Consolidate and simplify announcement and submission procedures.
  • Utilize efficiencies offered by electronic network technologies.
  • Allow greater flexibility while meeting stated departmental requirements.
  • Manage software in a manner similar to other STI products.

This transition will enable sites to continue announcing STI software through OSTI, but with the option to distribute software through OSTI, a SIAC, or site-hosted on-line access, depending on certain criteria of the software. The criteria for useful software that is to be centrally announced and the categories of software appropriate for site hosting or for submission to OSTI are described in Part III, Section 3.

2.0 Responsibilities

2.1 OSTI

OSTI, located in Oak Ridge, TN, serves as the Department's central announcement mechanism for DOE-sponsored software. It also serves as the Department's software management facility for the collection, licensing and distribution of Federally-funded software that is developed by national laboratories and other facilities/contractors of DOE (subject to the exceptions listed in paragraph 3.1). OSTI uses the services of the Energy Science and Technology Software Center (ESTSC) for software distribution.

OSTI also serves as the Department's liaison for software requests from sensitive countries. Upon a request for software from a sensitive country, OSTI coordinates any necessary reviews by the Office of Arms Control and Nonproliferation (NN-43) (see Section 4.2).

OSTI serves as the operating agent for implementing portions of the DOE international exchange agreements with the Nuclear Energy Agency (NEA) of the Organization for Economic Cooperation and Development (OECD), which provides for the exchange of nuclear-related scientific and technical software.

OSTI works with Specialized Information Analysis Centers (SIACs) - organizations sponsored by DOE to perform data analysis, including the collection, evaluation, announcement, and dissemination of computer software in specialized subject areas - to maximize their effectiveness, avoid duplication of efforts, and ensure that requesters are referred to an appropriate SIAC.

OSTI serves as the exclusive availability point, other than the copyright holder (or their licensees), for DOE and DOE-contractor originated software for which copyright has been asserted.

2.2 Specialized Information Analysis Centers (SIACs)

Specialized Information Analysis Centers may receive and make available software within their scope of interest/operation described below. SIACs should ensure that an announcement record is provided to OSTI for each software package they receive and make available. OSTI and the SIACs should work together to ensure the implementation of consistent procedures for the dissemination of computer software in accordance with DOE O 241.1. As determined by the applicable contract rights and technical data clause, OSTI may share the right to license and distribute the software through a specific agreement with an individual SIAC. Recognized SIACs, as of the date of this Guide, are:

  • The Radiation Safety Information Computational Center (RSICC) of the Radiation Information Analysis Section of the Oak Ridge National Laboratory (ORNL) specializes in computer programs and data sets pertinent to radiation transport and safety.
  • The National Nuclear Data Center (NNDC) of Brookhaven National Laboratory (BNL) specializes in computer programs and data sets pertinent to nuclear cross sections.
  • The Carbon Dioxide Information Analysis Center (CDIAC) of the Environmental Sciences Division of ORNL supports the nation's carbon dioxide-climate research effort by providing a focal point for the compilation and distribution of global-change-related information under systematic quality control.
  • The National Petroleum Technology Office (NPTO) specializes in oil reservoir engineering software designed to assist the petroleum industry and maximize the economic production of domestic oil.

2.3 Software Originators/Creators

To centrally announce the availability of DOE's STI products, each DOE and DOE contractor element that originates useful software is required by DOE O 241.1 to provide an announcement record (DOE F 241.x) to OSTI. The preference is electronic submission for OSTI to process the record and announce the software's availability to the appropriate audience (DOE, other Government agencies, the public, etc.).

The originating site may distribute the software by submitting it to OSTI or an appropriate SIAC or by using local distribution channels, as appropriate (see Table 1 and Section 4.1). Software originators should ensure all software meeting the exception criteria in Section 3.1 is reviewed by the Office of Arms Control and Nonproliferation (NN-43) prior to its announcement or submission.

As required by DOE O 241.1, software originators are to review all software for classified and unclassified sensitive information according to approved local procedures before sending to OSTI or a SIAC and before any distribution outside the organization is made. Software originators should also ensure all software is reviewed for export controlled information (see Attachment 7) in accordance with the Guidelines on Export Control and Nonproliferation, published by the Nuclear Transfer and Supplier Policy Division. The software should be clearly labeled if it is classified, contains unclassified sensitive information, or contains export controlled information. See Part II, Section 3, Appropriate Review Process to Release STI Products for Announcement, for instructions on labeling.

3.0 Software Announcement and Submission

3.1 STI Software Appropriate for Announcement

Organizations and individuals who have developed and/or modified software during work supported by DOE or during work carried out for others at DOE facilities are to announce the software with the appropriate announcement form (DOE F 241.x) to OSTI, if the software meets the following criteria:

  • The software meets the definition of STI as defined in Part I, Paragraph 4.0 of this Guide.
  • The software is known or expected to have broad usefulness within or outside the DOE community (i.e., is useful outside the originating site).
  • A stable, useable, documented version of the software exists (i.e., it is not developmental software).

Although all software that meets the above criteria are to be announced to OSTI, the software may be made available by either submitting the software package to OSTI or a SIAC (for software of applicable scope for a SIAC) or hosting the software on the originating site’s web server (e.g., applicable freeware).

Exclusions. Software that meets the above criteria need not be announced to OSTI if it falls under one of the following exclusions:

  • Operational systems software that is site-specific; so unique to a particular hardware, or necessary to ensure the fundamental operability of automated data processing equipment, whether supplied by the manufacturer of the system hardware or others and whether or not proprietary, which is not covered under a commercialization or copyright release request;
  • Computer software programs developed and/or modified during work carried out for others at DOE facilities specifically excluded in the agreement under which the non-DOE funded work was performed
  • Software generated under the auspices of the Energy Information Administration; and
  • The specific software used by Power Administrations for the operation, control, planning, and modeling of electric power transmission systems and the interconnected utilities. However, modification/enhancements to portions of this software that are not an integral part of the whole and have potential application outside the Power Administrations should be announced.

Exceptions: Software meeting the following criteria should be reviewed by the Office of Arms Control and Nonproliferation (NN-43) to determine if the public dissemination of the software would help proliferants. This review should be completed prior to announcing the software to OSTI, hosting the software on a web server, or submitting the software to OSTI or a SIAC.

  1. Any software code identified as containing Export Controlled Information (ECI) (see Attachment 7) by the Originator.
  2. Software codes that contain algorithms for any of the following:
  • hydrodynamics
  • radiative transfer
  • high explosives detonation
  • strength of materials
  • equations of state
  1. Any software code that can be used for coupled neutron/photon/electron codes.
  2. Compiled executables of the above.
  3. All codes that have a version that fits the criteria above, even if the version of the code lacks one of the components specified above.
  4. Any software code that would meet the above criteria if a publicly available code could easily be integrated into it.

3.2 Announcement/Submission Criteria

Software announcement requirements have been consolidated into one form (DOE F 241.x). To announce and make available a software package, the following components are considered necessary for inclusion in the package in order for the software to be provided to requesters:

  • Announcement record/metadata contained in DOE F 241.x, which includes all required information for announcing and describing the software;
  • Source code and/or executable file; and
  • Documentation, which may consist of a user manual, sample test cases, or similar information required for properly using the software (whether included in the software itself or provided in a separate file or in paper format)

3.3 Software Categories

Different categories of software have different distribution requirements or limitations. The table below defines the various software categories and identifies the appropriate distribution channels.

Table 1. Software Categories

Category

Description

Announcement

General
Availability
Classified Software that has been categorized according to DOE M 475.1-1

OSTI

OSTI

Declassified publicly releasable Previously classified software that has been declassified

OSTI

OSTI/SIAC/SITE

Unclassified sensitive or other protected Copyrighted – Software in which a DOE contractor has asserted rights.

Proprietary Data/Trade Secrets
Protected Data (e.g., software resulting from CRADA)

Small Business Innovation Research (SBIR)

Small Business Technology Transfer Research (STTR)

Unclassified Controlled Nuclear Information (UCNI) - (software that is protected by law from disclosure to persons not having a need-to-know the information without appropriate review by DOE).

OSTI/Limited Announcement

OSTI or in accordance with DOE-approved site agreements

Program-Directed Special Handling

Example:  

Applied Technology – software related to engineering, development, design, construction, operation, or other activities pertaining to nuclear technology advances (see Attachment 7 for details).

Export Controlled Information (ECI) Software containing unclassified information whose export is subject to export controls and whose unrestricted public dissemination could help proliferants or potential adversaries of the U.S. OSTI/Limited Announcement OSTI
Unclassified unlimited

(freeware, other)

Freeware – Software distributed, after all appropriate reviews, by the developing site at no charge. Freeware is thought to have general value to other application domains. The level of user support provided for freeware is determined by the developing site and communicated to the user. Freeware may be web hosted or distributed in other manners deemed appropriate by the sites. OSTI/Sites

(That is, OSTI and the sites may both announce the availability. OSTI will use data provided in DOE F 241.x in announcing the software.)

Sites

(Although OSTI will announce the software, the source of availability for requesters is the originating site.)

Other - Software that is not freeware according to the definition provided. This is software that a contractor develops, but does not copyright, and is fully willing to make available through OSTI or the specialized centers.

OSTI/SIAC/Sites

OSTI/SIAC/Sites

Note: This table is not intended to be an exhaustive list. If you have questions regarding the appropriate announcement or distribution channel, contact OSTI.

3.4 Announcement Record (Metadata)

Announcement record data is defined in DOE F 241.x. As part of the transition from centralized management to distributed access, effective January 2000, software metadata may be submitted electronically to OSTI using a web-based form or DTD-based batch files. The following table lists the data elements contained in the DOE F 241.x announcement record, with mandatory (M) and optional (O) fields noted.

Table 2. DOE SOFTWARE METADATA ELEMENTS

METADATA ELEMENT

M

O

DESCRIPTION

Record Status X

Identifies the software product as new or revised.
STI Product Title

X



The title, acronym and short KWIC (keywords in context) title of the software.
Software Developer(s)

X



Unlimited number is acceptable; the primary software developer should be listed first. Allows for "NONE" as an option for few cases where necessary.
E-mail Address(es)

X

Provide in same order as author names. Will not be available to the end-user.
Site Product Number

X Unique site number that identifies software product.
Contract Number

X



Required for all (can be "NONE").
R&D Project I.D.

X

A unique and permanent ID assigned to identify a particular research project or funding source.
Other Identifying Number(s)

X

If appropriate, includes CRADA number, LDRD number, B&R code, etc.
Originating Research Organization(s)

X



The organization/site submitting the software.
Release Date

X



Identifies the software release date. Standard format to be followed (e.g. follow rules of inputting), but requires standard 4-digit year.
Sponsoring Organization

X



The sponsoring or funding office of the work reported in the STI product. Allows for "NONE" as an option for few cases where necessary.
Description/Abstract

X



Text should be spell-checked, limited in length to 9000 characters, and follow input standards for special characters. Describe the purpose of the computer program, state the problem being solved and summarize the program functions and capabilities (highlight the advantages, distinguishing features and/or special capabilities). Provide a short summary of the mathematical methods, engineering principles, numerical algorithms and procedures incorporated into the software.
Hardware Requirements

X



Platform field with pick list: PC, Mac, Supercomputer, Mainframe, Multiplatform, Other
Software Requirements

Operating System and Version

Compiler and Version

Limitations/Restrictions/Timing requirement estimate/Other special requirements

Related/Auxiliary Software

Type of Files

X

X

X

X

X

X



Pick List: source code, text library, object library, user guide, executable module(s), auxiliary materials, compilation instructions, linking instructions, sample problem input data, sample problem output data, control information, program flow diagram, program flow data, programmer documentation, installation instructions, other
Media Type

X



Field: pick list with choices and sub-elements based on choice
Diskettes: number, type: IBM PC, Mac, UNIX workstation (tar format), capacity

Zip disk: number, type: IBM PC, Mac, UNIX workstation (tar format), capacity

Electronic transfer: URL or FTP (upload via E-Link)

8mm Cassette tapes: Number, capacity, format: ASCII/ANSI, UNIX TAR, VAX VMS back-up

Compact disk (CD): number, capacity

Documentation

X



Pick list: Paper, Electronic Document (with pick list for: URL, FTP, Online Documentation)Other Media
References

X

List citations of pertinent publications by author, title, report number, bar code, or order number if available, and date. References are to be broken down into two groupings: 1) reference documents provided with the submittal package and 2) additional background reference materials generally available.
Access Limitation

X



One selection is required. Non-conflicting multiples are allowed. Includes minimum supporting fields (e.g. release dates): Unlimited Announcement, OpenNet, U.S. Dissemination Only, Copyrighted Material, SBIR, STTR, Proprietary/Trade Secret, Patent Pending, Protected data, Program Directed Special Handling, Export Controlled Information (ECI), UCNI, Classified, Other information relevant to access
Availability (Refer requests to)

X

Required if applicable.
Contact

X



Site contact that will receive any external questions about the software.
Releasing Official

X



Site's designated official(s) who ensure that all appropriate sensitivity and export control reviews are completed (i.e. patent, copyright, UCNI, etc.)
Other

X

To be used for other useful information related to the software. Will be included in the published announcement record.

4.0 Software Access

4.1 Distribution of Software

After submission or announcement to OSTI, software may also be made available by the developing organization in accordance with the categories in Table 1, consistent with approved local procedures, and only with authorization of the cognizant management. Agreements to prevent further dissemination and to protect intellectual property rights should be obtained (See Table 1).

4.2 Software Dissemination

DOE O 241.1 requires that all scientific and technical information, including STI software, generated by DOE and its contractors be reviewed for sensitivity (including non-proliferation, national security, and export control) and appropriate announcement and availability restrictions applied. Software originators should not disseminate copies of software packages to foreign nationals without first ensuring the export is lawful in accordance with federal export regulations, to include those published by the Department of Commerce (15 CFR 730-774), the Department of Energy (10 CFR 810), the Department of State (22 CFR 120-130), and the Nuclear Regulatory Commission (10 CFR 110). Even dissemination of software packages to foreign nationals within the United States may be considered a "deemed export" and may require an export license in accordance with the federal export regulations.

All requests for software from sensitive countries must be sent to OSTI for coordination of approval from the Office of Arms Control and Nonproliferation (NN-43). If approved, the appropriate requesting site may then disseminate the software to the requester. The list of sensitive countries is available from the OSTI web site at http://www.osti.gov/estsc. (NN-43 is responsible for maintaining the list.)

4.3 License Agreements

4.3.1 Copyrighted Software

Software for which the developing DOE contractor organization has not asserted copyright (for commercialization purposes) is available to the public subject to the license agreement described below. Software for which the contractor has asserted such rights is not publicly disseminated but is available to DOE contractors and other government organizations from OSTI in accordance with the terms of the developer's contract with DOE. Requests for copyrighted software from those other than DOE contractors or governmental entities are referred by OSTI to the copyright holder (or their licensees) for licensing.

4.3.2 OSTI Software License

Any DOE-sponsored software package distributed by OSTI's ESTSC requires a license agreement. This form establishes conditions and requirements for requesters' use of the software package after purchase from OSTI's ESTSC. Requesters must return the properly completed and signed form to OSTI before order processing can be completed. OSTI encourages SIACs to follow this Departmental policy.

Under the international exchange agreement with the NEA, OSTI has determined that NEA distribution procedures are appropriately consistent with OSTI's licensing policy; and therefore, the NEA is not required to sign license forms for packages they receive from OSTI or SIAC's covered by the exchange agreement.

4.3.3 Disclaimers for Software

Rights-in-technical-data clauses for many DOE contracts require a statement acknowledging DOE sponsorship/data rights for information products. The following distribution statement and disclaimers meet those requirements for software and should be affixed to all distributed DOE-sponsored software. Any appropriate additional markings that are desired should be reviewed by legal counsel and consistent with restrictions indicated on the announcement form (DOE F 241.x). Markings should be affixed to all software package elements provided to the OSTI or a SIAC.

Distribution Statement

"This computer software has been developed under sponsorship of the U.S. Department of Energy. Any further distribution or use by anyone other than the named licensee of this software package or any data contained therein, unless otherwise specifically provided for, is prohibited without the approval of the Office of Scientific and Technical Information. Requests for DOE-developed computer software shall be referred to the Energy Science and Technology Software Center at the Office of Scientific and Technical Information, P.O. Box 1020, Oak Ridge, TN 37831-1020."

Disclaimer

"This material was prepared as an account of work sponsored by an agency of the United States Government. Neither the United States Government nor the United States Department of Energy, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights."

 

Last page update:  8/21/03