diff --git a/README.rst b/README.rst index a251c3a4a04fa5591a2c08c28ff4f34a56bfbda1..b62b5285b4c552585ee96c4cb35a3dd09d1f4336 100644 --- a/README.rst +++ b/README.rst @@ -70,15 +70,26 @@ In additional install pyDetLib package, which is required for many notebooks:: pip install -r requirements.txt pip install . +++++++++++++++++++++++++++++++++++++++++++++++++++ +Setting an ipython kernel for virtual environments +++++++++++++++++++++++++++++++++++++++++++++++++++ + +To set a kernel for your virtual environment:: + + source /path/to/new/virtual/environment/bin/activate + pip install ipykernel + python -m ipykernel install --user --name <virtenv-name> --display-name "virtenv-display-name" + +This can be useful for Jupyter notebook tools as "max-jhub.desy.de". Development Installation ------------------------ -For a development installation in your home directory, which automatically +For a development installation, which automatically picks up (most) changes, first install the dependencies as above, -but then install the tool-chain separately in development mode:: +but then install the tool-chain separately in development mode (install in home directory using --user, in case of using Anaconda/3):: - pip install -e . --user + pip install -e . Activate Offline calibration