Skip to main content
U.S. flag

An official website of the United States government

Fundamental Science Practices for release of approved versus provisional USGS scientific software, review and approval of software, disclaimers, versioning, software licenses, scripts and models, and digital object identifiers.

Filter Total Items: 22
May I use publicly available, third-party code – possibly developed by an external collaborator – to conduct USGS research? [222]

May I use publicly available, third-party code – possibly developed by an external collaborator – to conduct USGS research? [222]

Yes. Publicly available, third-party code may be used to support USGS research as specified in SM 502.11. [Read More]
Learn More
How do I document a review for a scientific software information product in the Information Product Data System (IPDS)? [221]

How do I document a review for a scientific software information product in the Information Product Data System (IPDS)? [221]

USGS scientific software information product review and reconciliation documents may be attached to an IPDS record to document the process. [Read More]
Learn More

How can I make a software project available for review by external reviewers prior to releasing e USGS scientific software product? [220] How can I make a software project available for review by external reviewers prior to releasing e USGS scientific software product? [220]

Two options exist: First, the approved USGS hosting platforms support external collaborator accounts. Second, the software project may be made publicly accessible as an open-source software development project. [Read More]
How can I make a software project available for review by external reviewers prior to releasing e USGS scientific software product? [220]

How can I make a software project available for review by external reviewers prior to releasing e USGS scientific software product? [220]

Two options exist: First, the approved USGS hosting platforms support external collaborator accounts. Second, the software project may be made publicly accessible as an open-source software development project. [Read More]
Learn More

When and how should scientific software information products be reviewed? [218] When and how should scientific software information products be reviewed? [218]

Scientific software information products may be reviewed incrementally as part of the development process or in aggregate just prior to becoming public. [Read More]
When and how should scientific software information products be reviewed? [218]

When and how should scientific software information products be reviewed? [218]

Scientific software information products may be reviewed incrementally as part of the development process or in aggregate just prior to becoming public. [Read More]
Learn More

May scientific software information products be released without first being publicly accessible as an open-source software project? [216] May scientific software information products be released without first being publicly accessible as an open-source software project? [216]

Yes. Scientific software information products may be released either concurrent with- or subsequent to- the corresponding open-source software project being made publicly accessible. However, all requirements of Federal Policy must be satisfied when doing so. [Read More]
May scientific software information products be released without first being publicly accessible as an open-source software project? [216]

May scientific software information products be released without first being publicly accessible as an open-source software project? [216]

Yes. Scientific software information products may be released either concurrent with- or subsequent to- the corresponding open-source software project being made publicly accessible. However, all requirements of Federal Policy must be satisfied when doing so. [Read More]
Learn More

May custom-developed software projects be publicly accessible? [215] May custom-developed software projects be publicly accessible? [215]

Yes. USGS software projects may be made publicly available as open-source software projects (refer to the SHARE IT Act) but are not citable by other USGS products.
May custom-developed software projects be publicly accessible? [215]

May custom-developed software projects be publicly accessible? [215]

Yes. USGS software projects may be made publicly available as open-source software projects (refer to the SHARE IT Act) but are not citable by other USGS products.
Learn More
My custom-developed source code does not rise to the level of a scientific software information product. Do I need to release my code as a USGS Scientific Software Release following SM 502.11? [214]

My custom-developed source code does not rise to the level of a scientific software information product. Do I need to release my code as a USGS Scientific Software Release following SM 502.11? [214]

No. However, most custom-developed source code is still governed by ACIO Open Source Software requirements, and the SHARE IT Act, which have their own release requirements (but are outside of the scope of SM 502.11). [Read more]
Learn More

How do FSP requirements for release of scientific software compare to those for release of scientific data? [060] How do FSP requirements for release of scientific software compare to those for release of scientific data? [060]

USGS scientific software information products and scientific data products follow similar FSP requirements for review and approval. Both are considered noninterpretive information. Scientific data are subject to the requirements of the OPEN Government Data Act while scientific software information products are subject to the SHARE IT Act. [Read more]
How do FSP requirements for release of scientific software compare to those for release of scientific data? [060]

How do FSP requirements for release of scientific software compare to those for release of scientific data? [060]

USGS scientific software information products and scientific data products follow similar FSP requirements for review and approval. Both are considered noninterpretive information. Scientific data are subject to the requirements of the OPEN Government Data Act while scientific software information products are subject to the SHARE IT Act. [Read more]
Learn More
What information must be in IPDS for a publication under review, relevant to data/software to allow bureau approval from a BAO? [073]

What information must be in IPDS for a publication under review, relevant to data/software to allow bureau approval from a BAO? [073]

The IPDS record of the manuscript must contain the IP number and DOI of the accompanying data/software release. [Read more]
Learn More
What are the differences between an open-source software project and a scientific software information product? [076]

What are the differences between an open-source software project and a scientific software information product? [076]

While open-source software projects and scientific software information products are both publicly accessible, they differ in significant ways. [Read more]
Learn More

When may and when must software be released as a USGS scientific software information product? [077] When may and when must software be released as a USGS scientific software information product? [077]

Scientific software is ready for approval and public release when a version of the software is no longer under development, includes the appropriate documentation, and has been reviewed in accordance with SM 502.11 requirements. [Read more]
When may and when must software be released as a USGS scientific software information product? [077]

When may and when must software be released as a USGS scientific software information product? [077]

Scientific software is ready for approval and public release when a version of the software is no longer under development, includes the appropriate documentation, and has been reviewed in accordance with SM 502.11 requirements. [Read more]
Learn More

How is USGS scientific software released? [095] How is USGS scientific software released? [095]

USGS scientific software information products must be released following the requirements described in SM 502.11 and may be cited like any other published work. [Read More]
How is USGS scientific software released? [095]

How is USGS scientific software released? [095]

USGS scientific software information products must be released following the requirements described in SM 502.11 and may be cited like any other published work. [Read More]
Learn More
What disclaimer statement(s) are required for a USGS scientific software information product? [134]

What disclaimer statement(s) are required for a USGS scientific software information product? [134]

Software projects are hosted within a version control system (VCS). [Read more]
Learn More

When does a software release product require a version number? [135] When does a software release product require a version number? [135]

Because software may be further developed and subsequently updated after the original version is released, all revised software should be released with a new version number. Although the approach to version numbering can vary, revised software releases can be grouped into three general categories: major revision, minor revision, and patch. [Read more]
When does a software release product require a version number? [135]

When does a software release product require a version number? [135]

Because software may be further developed and subsequently updated after the original version is released, all revised software should be released with a new version number. Although the approach to version numbering can vary, revised software releases can be grouped into three general categories: major revision, minor revision, and patch. [Read more]
Learn More

Can I contribute code to open source projects, and if so, how should I identify and document my contributions? [136] Can I contribute code to open source projects, and if so, how should I identify and document my contributions? [136]

Yes. Software produced by the USGS and released publicly is in the public domain. However, some software may be partially or wholly owned by a non-Federal partner (e.g., university) and may elect to apply a license, including an open source license that includes restrictions. USGS employees have several options to navigate these circumstances. [Read more]
Can I contribute code to open source projects, and if so, how should I identify and document my contributions? [136]

Can I contribute code to open source projects, and if so, how should I identify and document my contributions? [136]

Yes. Software produced by the USGS and released publicly is in the public domain. However, some software may be partially or wholly owned by a non-Federal partner (e.g., university) and may elect to apply a license, including an open source license that includes restrictions. USGS employees have several options to navigate these circumstances. [Read more]
Learn More

How must USGS scientific software information products be licensed? [137] How must USGS scientific software information products be licensed? [137]

In the United States, an original work of the U.S. Government is not eligible for copyright protection (17 USC 105a) and is automatically in the public domain. These works should include a license file with a public domain dedication statement to notify the public of the copyright status of the software. [Read more]
How must USGS scientific software information products be licensed? [137]

How must USGS scientific software information products be licensed? [137]

In the United States, an original work of the U.S. Government is not eligible for copyright protection (17 USC 105a) and is automatically in the public domain. These works should include a license file with a public domain dedication statement to notify the public of the copyright status of the software. [Read more]
Learn More

What is required to comply with Federal Source Code Policy? [138] What is required to comply with Federal Source Code Policy? [138]

Generally, source code associated with USGS software releases must be made available at minimum for Federal Government-wide reuse. Source code for USGS software releases must include an appropriate open-source license or secured re-use rights; be included in the USGS source code inventory; be accompanied by documentation to facilitate reuse and participation by third parties. [Read more]
What is required to comply with Federal Source Code Policy? [138]

What is required to comply with Federal Source Code Policy? [138]

Generally, source code associated with USGS software releases must be made available at minimum for Federal Government-wide reuse. Source code for USGS software releases must include an appropriate open-source license or secured re-use rights; be included in the USGS source code inventory; be accompanied by documentation to facilitate reuse and participation by third parties. [Read more]
Learn More
Do USGS scientific software information products require a Digital Object Identifier (DOI)? [139]

Do USGS scientific software information products require a Digital Object Identifier (DOI)? [139]

Yes. USGS scientific software information products must be assigned a DOI with the 10.5066 prefix. [Read more]
Learn More

When should software not be developed publicly? [140] When should software not be developed publicly? [140]

Department of the Interior, including USGS, applies strict requirements and platform authorizations for sharing software in public repositories. To avoid potential violations, policy-compliant and secure internal code repositories are available for sharing and releasing software. [Read more]
When should software not be developed publicly? [140]

When should software not be developed publicly? [140]

Department of the Interior, including USGS, applies strict requirements and platform authorizations for sharing software in public repositories. To avoid potential violations, policy-compliant and secure internal code repositories are available for sharing and releasing software. [Read more]
Learn More

What is the distinction in software release requirements between scripts used to prepare data for analysis or graphical visualizations and models or other packages of source code? [141] What is the distinction in software release requirements between scripts used to prepare data for analysis or graphical visualizations and models or other packages of source code? [141]

Author should work together with their supervisor and Science Center Director to determine if a set of source code is appropriate for release as a USGS scientific software release or if the algorithms or statistical methods would alternatively be more appropriate for inclusion in an associated manuscript or the metadata of a data release. [Read more]
What is the distinction in software release requirements between scripts used to prepare data for analysis or graphical visualizations and models or other packages of source code? [141]

What is the distinction in software release requirements between scripts used to prepare data for analysis or graphical visualizations and models or other packages of source code? [141]

Author should work together with their supervisor and Science Center Director to determine if a set of source code is appropriate for release as a USGS scientific software release or if the algorithms or statistical methods would alternatively be more appropriate for inclusion in an associated manuscript or the metadata of a data release. [Read more]
Learn More

Where must USGS scientific software information products be hosted? [142] Where must USGS scientific software information products be hosted? [142]

The authoritative or original reference copy of all USGS scientific software information products must be maintained on an approved platform. As of the writing of this FAQ, these the two platforms options were (1) https://code.usgs.gov/ or (2) https://github.com/doi-usgs/. [Read more]
Where must USGS scientific software information products be hosted? [142]

Where must USGS scientific software information products be hosted? [142]

The authoritative or original reference copy of all USGS scientific software information products must be maintained on an approved platform. As of the writing of this FAQ, these the two platforms options were (1) https://code.usgs.gov/ or (2) https://github.com/doi-usgs/. [Read more]
Learn More
Was this page helpful?