add developer guide for loading data #74
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #74 +/- ##
=======================================
Coverage 48.76% 48.76%
=======================================
Files 4 4
Lines 121 121
=======================================
Hits 59 59
Misses 62 62 ☔ View full report in Codecov by Sentry. |
| ### 1. Create SSH Tunnel: | ||
|
|
||
| Execute the following command to create an SSH tunnel to the remote server (`login1.berkeley.kbase.us`): | ||
|
|
||
| ```bash | ||
| ssh -f -N -L localhost:44041:10.58.2.201:4041 <ac.anl_username>@login1.berkeley.kbase.us | ||
| ``` |
There was a problem hiding this comment.
I thought we already had docs like this somewhere?
There was a problem hiding this comment.
yea. Similar instructions in the user's guide. https://github.com/kbase/cdm-jupyterhub/blob/main/docs/user_guide.md
But dev has different port number. That's also the reason I didn't make it as detailed as the user's guide.
There was a problem hiding this comment.
Maybe link to the user guide for more info?
docs/dev_guide.md
Outdated
| 🚨 **Please DO NOT rerun the loading notebooks in the development environment. Instead, create a new notebook for each | ||
| new namespace and manually verify the data loading process.** |
There was a problem hiding this comment.
I'm not totally sure what this means. If you need to reload the data shouldn't you reuse the notebook?
There was a problem hiding this comment.
Updated the note to make it more clear. I was trying to prevent people running existing loading notebook and accidentally update existing tables.
There was a problem hiding this comment.
Is there anything that should be added about ensuring the notebook works when overwriting as opposed to loading clean? I'm not sure there's a guarantee that a notebook can be run without dropping the tables first
There was a problem hiding this comment.
I think that's fine for now. I haven't thoroughly tested the process of reloading or altering tables yet. For now, I just want to ensure people only load/update their own tables and avoid modifying others' tables. I've observed that people often rerun notebooks to check the output for convenience.
No description provided.