Skip to content

Commit 15edb35

Browse files
committed
Add files documentation
1 parent cbc3910 commit 15edb35

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

docs/files.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,22 @@ Verify a path exists before using it:
3030
ds.files.to_uri("/MyData/analysis/input/", verify_exists=True)
3131
```
3232

33-
Reverse translation (URI back to Jupyter path):
33+
Reverse translation (URI back to Jupyter path, where `~` is `/home/jupyter` on DesignSafe JupyterHub):
3434

3535
```python
3636
ds.files.to_path("tapis://designsafe.storage.default/<username>/data/file.txt")
37-
# /home/jupyter/MyData/data/file.txt
37+
# ~/MyData/data/file.txt
3838

3939
ds.files.to_path("tapis://designsafe.storage.community/datasets/eq.csv")
40-
# /home/jupyter/CommunityData/datasets/eq.csv
40+
# ~/CommunityData/datasets/eq.csv
4141
```
4242

4343
### Supported path formats
4444

4545
| Input path | Tapis system |
4646
|---|---|
4747
| `/MyData/...` | `designsafe.storage.default/<username>/...` |
48-
| `/home/jupyter/MyData/...` | `designsafe.storage.default/<username>/...` |
48+
| `~/MyData/...` | `designsafe.storage.default/<username>/...` |
4949
| `jupyter/MyData/...` | `designsafe.storage.default/<username>/...` |
5050
| `/CommunityData/...` | `designsafe.storage.community/...` |
5151
| `/projects/PRJ-XXXX/...` | `project-<uuid>/...` (auto-discovered) |

0 commit comments

Comments
 (0)