Skip to content

Commit f63af47

Browse files
committed
fix: link to "Research Software Best Practices"
1 parent a9d3545 commit f63af47

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

user-guide/curating/bestpractices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Many times users include or small subsets of data/demo files to their research s
9595

9696
##### Jupyter Notebooks as Research Software
9797

98-
If planning to publish a Jupyter Notebook in the DDR, the content must comply with the definition of research software available in the [Research Software Publication Policy](/user-guide/curating/policies/#publishing-research-software). Thus, the content of the Jupyter Notebook must be a contribution to solving a scientific problem. It should also comply with Research Software Best Practices outlined above.
98+
If planning to publish a Jupyter Notebook in the DDR, the content must comply with the definition of research software available in the [Research Software Publication Policy](/user-guide/curating/policies/#publishing-research-software). Thus, the content of the Jupyter Notebook must be a contribution to solving a scientific problem. It should also comply with [Research Software Best Practices](#research-software) outlined above.
9999

100100
Jupyter Notebooks, published via GitHub or as Project Type Other should be self-contained and should not depend on file paths on DesignSafe computing resources or external file systems. Please see [instructions on how to publish Jupyter Notebooks](/user-guide/tools/jupyterhub/#publishing-notebooks).
101101

user-guide/curating/policies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -576,13 +576,13 @@ Below are the requirements for publishing research software in the DDR:
576576

577577
* Research software should be open source, which includes being distributed with an open source license. The software license offered in the Data Depot is the 3-Clause BSD License.
578578
* If the research software uses libraries/dependencies, their respective licenses should allow reuse without restrictions.
579-
* Within the publication package a CodeMeta file (in `json` format) with information that allows for attribution, dissemination, reuse, and interoperability of the research software should be included.
579+
* Within the publication package a [CodeMeta file (in `json` format)](https://codemeta.github.io/codemeta-generator/) with information that allows for attribution, dissemination, reuse, and interoperability of the research software should be included.
580580
* Also include a `Readme` file that explains how to install and use the software.
581581
* Prior to publishing, users agree that the software is functional and works according to the instructions provided in the readme file.
582582
* Research software should be self contained. While it should be possible to use the software with published data in DesignSafe or within DesignSafe Tools and Applications, it should not be written such that it is dependent on absolute file paths in DesignSafe data publications or on external file systems.
583583
* Research software publications should not include datasets. Instead datasets that are used by the research software for training, testing, validation, etc. should be published as a stand-alone datasets and linked to the research software publication via the Related Work/linked entry available in the curation form. In turn, a dataset can be related to the research software publication via the Referenced Data and Software/cites entry available in the curation form.
584584
* The citation and DOI obtained should be included in the GitHub repo and [show as Cite this Repository](/user-guide/curating/github-cite-this-repo/).
585-
* For guidance on publishing good quality research software, see Research Software Best Practices.
585+
* For guidance on publishing good quality research software, see [Research Software Best Practices](/user-guide/curating/bestpractices/#research-software).
586586

587587
What does not qualify as research software:
588588

0 commit comments

Comments
 (0)