This repository contains a kernel specification for executing JupyterLab notebooks which use the the Rubin Observatory Legacy Survey of Space and Time (LSST) science pipelines.
Once deployed in the host where your JupyterLab notebook server executes (e.g. your laptop or a remote server such as the ones at CC-IN2P3, you will be able to launch notebooks which use a Python interpreter configured with all the packages specific to the LSST software distribution.
When you launch JupyterLab, you will see a screen similar to the one below:
Push the lsst_distrib button to launch a server already configured to use the LSST science pipelines.
This kernel specification requires that the LSST science pipelines are installed on the host where JupyterLab executes, under /cvmfs/sw.lsst.eu (see https://sw.lsst.eu for more information). The hosts at the CC-IN2P3 login farm are configured this way.
Execute the instructions below in the computer where you run JupyterLab (e.g. your laptop or a server in CC-IN2P3 login farm).
cd $HOME
git clone https://github.com/airnandez/lsst-jupyter-kernel.git
cd lsst-jupyter-kernel
bash ./install.sh
rm -r $HOME/lsst-jupyter-kernel
After a successful installation, you will find a directory located according to the operating system you deploy on, as follows:
| Operating system | Installation directory |
|---|---|
| Linux | $HOME/.local/share/jupyter/kernels/lsst_distrib |
| macOS | $HOME/Library/Jupyter/kernels/lsst_distrib |
This directory is populated with files needed by JupyterLab to launch your notebook.
You can customize the Jupyter kernel specification installed in the previous step. In particular, you can specify the release of the pipelines you want to use for your notebooks. By default, the release used is the lastest weekly release of the lsst_distrib distribution available when your notebook is launched. If you need a specific fixed version, modify the file kernel.json in the installation directory (see above) by specifying which release you need.
For instance, if you want to use the release w_2020_10 on all your notebooks, modify the line:
"LSST_DISTRIB_RELEASE": "latest"
by the line:
"LSST_DISTRIB_RELEASE": "w_2020_10"
This tool was developed and are maintained by Fabio Hernandez at IN2P3 / CNRS computing center (Lyon, France).
Copyright 2020 Fabio Hernandez
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.