FSP FAQs: Software
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: 27
How may external collaborators add to USGS software projects and maintain “credit” for their individual contributions to USGS products? [227] How may external collaborators add to USGS software projects and maintain “credit” for their individual contributions to USGS products? [227]
External collaborators may add to a USGS software project that has been made accessible as an open-source development project on the USGS Git Hosting Platform. [Read More]
How is a USGS scientific software information product cited? [226] How is a USGS scientific software information product cited? [226]
As defined in SM 502.11, USGS scientific software information products may be cited; however, the corresponding software project may not be cited or referred to within another information product. [Read More]
How can I enforce a USGS policy on external collaborators? [225] How can I enforce a USGS policy on external collaborators? [225]
As the lead author on a USGS scientific software information product, it is your responsibility to ensure all Fundamental Science Practices (FSP) requirements are satisfied before publishing the code. Including a contributing file, “CONTRIBUTING.md,” in your software repository can make clear the conditions under which the USGS will accept contributions from external collaborators. [Read More]
How is legacy software handled under current USGS policy? [224] How is legacy software handled under current USGS policy? [224]
Legacy software (specifically, software created prior to the release of SM 502.11) may remain as-is so long as it remains compliant with the policies governing its original publication. If an updated publication of legacy software is desired, the software project must be updated to comply with current policy.
What happened to the previous concept of a provisional software release? [223] What happened to the previous concept of a provisional software release? [223]
Software projects that were previously released as provisional software under OSQI IM 2019-01 are now considered open-source software development projects under the authority of the USGS Open Source Software Requirements.
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]
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]
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]
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]
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 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.
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]
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]
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]
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]
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]
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]
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]
How are USGS scientific software information products versioned? [135] How are USGS scientific software information products versioned? [135]
USGS scientific software information products should follow semantic versioning. [Read more]
May I contribute code to open-source projects, and if so, how should I identify and document my contributions? [136] May I contribute code to open-source projects, and if so, how should I identify and document my contributions? [136]
Yes. USGS contributions of custom-developed code to existing software licensed through third-party entities are encouraged. However, when possible, these contributions should be annotated as freely available in the public domain. [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]