liznaluminsa / example-notebooks Goto Github PK

• Description
• Installation
• Updating
• Contributing
• Contact

This repository contains example notebooks that can help you start using SciServer for your data science and science education projects. Use these example notebooks to learn Python syntax, and as templates for creating your own notebooks.

The easiest way to get these Example Notebooks is to log in to SciServer and go to SciServer Compute. Click Create Container to open the Create Container dialog box. At the bottom of the newly-opened dialog box, you will see a list of Data volumes. Be sure the checkbox next to Getting started is checked.

Once you create the container with the Getting Started data volume mounted, you can access these example notebooks from within Compute by going to the getting_started volume. They are in the Example-Notebooks folder.

The Getting Started data volume is read-only, so you may run the notebooks but not make changes to them. The first thing you should do is to copy them into your persistent volume by running the Copy Example Notebooks.ipynb notebook. Doing so will create a new folder called examples inside your persistent volume, with read/write copies of all these notebooks. You can then change the notebooks, see what the changes do, and save your changes.

Alternatively, if you are familiar with GitHub, you can directly clone the files into your SciServer file system space by opening a new Python notebook and running the following command - you will need to include the exclamation point at the beginning for it to run correctly:

!git clone https://github.com/sciserver/Example-Notebooks.git {local directory name}

In the future, we may occasionally change these example notebooks, to add new examples or to take advantage of new SciServer features. Once we have made those future changes, you can integrate the changes into the Example Notebook copies you have made in your user volume.

To get the latest versions, create a new Python 3 notebook and add this command to the first cell:

!git pull

Be sure to include the exclamation point as the first character.

Run this command. Our version management system (git) will do its best to seamlessly merge the new updates with your changes. If it is unable to do so, it will generate a conflict. To learn how to resolve conflicts, see GitHub's guide to resolving conflicts.

We encourage you to adapt and use these example notebooks any way you wish! If you would like to share your contributions with us and with other SciServer users, let us know by emailing the SciServer Helpdesk at [email protected].

For technical questions or to report a bug, please email [email protected].

For more information about SciServer, what it is, and what you can do with it, please visit www.sciserver.org.