-
Notifications
You must be signed in to change notification settings - Fork 18
Description
Right now our "notebook" is a Jupyter Notebook in JSON format. However in reality the results of our data analysis usually consist of a notebook, and various result files such as figures and tables. It would be helpful to have a generalized concept of Notebook that includes these components.
For example,
Notebook storage
- A notebook is a directory that consists of a notebook (the only one or
index.ipynbif there are multiple notebooks). The directory can have multiple external files. - The notebook can stay in the format of a directory, a semi-directory like "apps" in MacOSX, or a compressed file (e.g. with extension
.sosnb), depending on how the notebook is stored or transferred. - The notebook could include hidden maintenance files such as revision log, access log, comments etc, perhaps in a
.sosfolder.
Viewing SoS notebooks
-
When we store the notebook in SoS Portal (or something of that nature), it is "viewed" as a single notebook, that shows the primary notebook and the attachments, with option to "download" the attachments.
-
The viewer could preview the attached files statically (through
%preview), or dynamically if a live server is available to present the content to viewers. That is to say, if we have a server to serve the notebook to others, the website could change dynamically with the change of underlying notebook or attachment.
Editing SoS notebooks
- Jupyter Notebook and Jupyter Lab can continue to edit the notebook.
- Regular file operations can be used to add/edit/remove files in the directory.
- An automatic "attachment" section could be added to the notebook to show all attached files.