Knowledgebase
10.08 Jupyter Integration
Posted by Sherry Cusano on 20 November 2020 07:05 AM

Our Integration with Jupyter allows you to view .ipynb files within your LabArchives Notebook. To open the Jupyter Viewer, hover your cursor over the .ipynb file thumbnail where it appears on your Notebook Page and click the View Icon (eyeball). You can also download a copy of this .ipynb file to your device hard drive at any time via the download icon.

The Jupyter viewer will show all your code and embedded visualizations, and your content is organized into cells just as it is in Jupyter. An example of this is shown below:

On the notebook page, a thumbnail preview of your .ipynb file content will be displayed, as in the below screenshot:

By importing your .ipynb files into LabArchives, you can now include the work they contain as part of the narrative your LabArchives notebook tells about your research. You no longer need to open these files in Jupyter separately to view their content. Furthermore, any visualization generated in your Jupyter Notebook can be viewed in LabArchives directly; no need to screenshot this or otherwise export this as a separate image file before uploading. Finally, the rich revision history features of LabArchives entries can now be applied to these .ipynb files as well. For more information on the LabArchives Revision history, click here.

If you are actively changing one or more .ipynb files, you have two options. You can edit the original file and upload the updated copy of that file, or you could consider using Folder Monitor. Folder Monitor may be ideal if you are making multiple updates to one or more .ipynb files over time, as it can automatically sync these changes to a LabArchives Notebook and Folder of your choosing. Using the File Filter feature of Folder Monitor is a good idea here, in case you want to avoid uploading any other documents or different files adjacent to your .ipynb files. For more information on Folder Monitor for Mac, click here. For more information on Folder Monitor for Windows, click here.

Note: All .ipynb files are read-only when uploaded as attachment entries to a LabArchives Notebook.

Note: Horizontal scrolling is currently not supported for the Jupyter viewer. Consider using a continuation character (such as the ‘ \ ‘ character in Python) to break up long strings or code-lines into multiple lines for the best viewing experience.

Note: If you have previously uploaded an .ipynb file to your LabArchives notebook, and its thumbnail is not displaying, try replacing this file with the current version on your hard drive. This should trigger the thumbnail to regenerate. If it does not, please contact support@labarchives.com

(0 vote(s))
Helpful
Not helpful