Skip to content

Update Jupyter documentation to explain relative paths#220

Merged
wesleyboar merged 1 commit into
mainfrom
relative-paths-jupyter
Oct 27, 2025
Merged

Update Jupyter documentation to explain relative paths#220
wesleyboar merged 1 commit into
mainfrom
relative-paths-jupyter

Conversation

@jarosenb

Copy link
Copy Markdown
Member

Encourage users to use relative paths in Jupyter notebooks, with an explanation of the concept and a worked example with some common patterns.

@jarosenb
jarosenb requested a review from wesleyboar October 23, 2025 14:41
@silviamazzoni

Copy link
Copy Markdown
Contributor

You can find this (and more) in the OpenSees-on-DesignSafe Training Documentation:
https://designsafe-ci.github.io/training-OpenSees-on-DesignSafe/Docs_MD/Paths_Overview.html

Comment thread user-guide/docs/curating/bestpractices.md Outdated
@wesleyboar

wesleyboar commented Oct 23, 2025

Copy link
Copy Markdown
Collaborator

@mesteva,

Are you okay with this change here?

I think that page is not an appropriate location for such technical information.

And @silviamazzoni says that technical information available in training docs that DS User Guide links out too.

I've also pinged @mesteva internally, and will carry over her answer if that is where she replies.

@silviamazzoni

Copy link
Copy Markdown
Contributor

Also, whether you use relative or absolute paths depends on your task.

@wesleyboar wesleyboar left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I got answers.

@silviamazzoni

Copy link
Copy Markdown
Contributor

@wesleyboar ,
in . Here is an example of a published notebook that writes files to user directories. you have a link to the data depot, i would recommend you add also give the option to open the notebook directly in Jupyter Hub.

@jarosenb
jarosenb force-pushed the relative-paths-jupyter branch from 3b8e22f to 21636ed Compare October 27, 2025 20:31
@wesleyboar
wesleyboar merged commit 646a7d8 into main Oct 27, 2025
@wesleyboar
wesleyboar deleted the relative-paths-jupyter branch October 27, 2025 20:52
@wesleyboar

Copy link
Copy Markdown
Collaborator

Thanks. Merged.

I will add M.E.'s change in a follow-up PR.

I will consider S.M.'s suggestions for follow-up improvements.

wesleyboar added a commit that referenced this pull request Oct 27, 2025
This is why #220 was changed, because this content is to be rewritten, non-technical.
@wesleyboar

Copy link
Copy Markdown
Collaborator

@silviamazzoni, I've moved your idea to #224.1

Footnotes

  1. Autumn is busy time at TACC, and DS work is currently slowed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants