Getting Started#
There are currently three possiblities for running SLEEPY: with a local Python installation, online via Google Colab, or online via myBinder.org. A local installation of SLEEPY may be run in Jupyter notebooks, as a script, or in a Python/iPython terminal. Here we provide a few notes for a local installation or for running in Google Colab.
Local Installation#
The stable version of SLEEPY can be installed with pip (or alternatively downloaded from PyPI):
pip install sleepy-nmr
Note that the resulting module is called SLEEPY, as opposed to sleepy-nmr. Import as follows (shortening name to ‘sl’ is optional)
import SLEEPY as sl
SLEEPY does not exist for installation via conda, but package requirements for SLEEPY are relatively limited (numpy, scipy, matplotlib), so installing via pip is unlikely to break your conda installation.
For the latest (potentially less stable) version of SLEEPY, download from GitHub and add its folder to your system path. The required modules must be installed separately by the user.
Versions listed have been tested for SLEEPY, although any recent module version should work.
Requirements#
Python 3 (3.7.3)
numpy (1.19.2)
matplotlib (3.4.2)
scipy (1.5.2)
Recommended Installations#
Jupyter notebooks: Neat code organization based in a web browser
If you’re starting from scratch, you may consider installing Anaconda, which will install Python 3, numpy, matplotlib, scipy, and Jupyter Notebooks for you.
Once set up, any of the webpages with code in the tutorial can be downloaded with the button in the upper right (pick .ipynb) and run locally.
Google Colab#
Colab has the advantage that there is no local installation requirement, with the basic Python modules already setup. The notebooks that we provide include a few lines at the beginning that download SLEEPY and import it.
For all notebooks in the tutorial, there is a button near the top that redirects you to Google Colab, where you can then edit and execute contents of the notebook: 