Skip to content

Update bestpractices.md #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2025
Merged

Update bestpractices.md #229

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
476eb8e
Update bestpractices.md
cockerilltim Nov 10, 2025
830a15d
Merge branch 'main' into cockerilltim-patch-2
wesleyboar Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions user-guide/docs/curating/bestpractices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,9 @@ Many times users include or small subsets of data/demo files to their research s

##### Jupyter Notebooks as Research Software

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/docs/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.
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.

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/docs/tools/jupyterhub/publishingnotebooks.md).
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).

Many users publish notebooks along with a sample dataset or in connection to a published dataset. Always reference the dataset in the Related Data and Software entry.

Expand Down Expand Up @@ -373,4 +373,4 @@ Users can click a “Leave Feedback” button on the projects’ landing pages t
* Request to access raw data if not published.
* Requests to access restricted data if the authors authorize it. 
* Issues related to published code that is not working properly.
* Congratulations.
* Congratulations.