From e4844cf3d183d7f047c9151860099bb2885c8157 Mon Sep 17 00:00:00 2001 From: JoepVanlier Date: Fri, 17 Feb 2023 17:23:31 +0100 Subject: [PATCH] docs: add specific jupyter kernel to instructions --- docs/install.rst | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 6f347754d..9025fc9f5 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -47,9 +47,16 @@ The easiest way to install Python and SciPy is with `Anaconda`_, a free scientif conda config --add channels conda-forge -#. We can install Pylake in this environment by invoking the following command:: +#. We can install Pylake in this environment by invoking the following command: - conda install lumicks.pylake + .. code-block:: + + conda install lumicks.pylake "jupyter_client<8" + + .. note:: + + There is currently an `open issue `_ with Jupyter that results in communication problems between Jupyter notebooks and the Jupyter kernel. + As a workaround, we temporarily suggest adding the constraint `jupyter_client<8` to install an older version of this kernel. #. It should be possible to open a jupyter notebook in this environment by calling:: @@ -92,9 +99,16 @@ This concludes the Pylake installation procedure. Check out the :doc:`Tutorial < conda config --add channels conda-forge -#. We can install Pylake in this environment by invoking the following command:: +#. We can install Pylake in this environment by invoking the following command: + + .. code-block:: + + conda install lumicks.pylake "jupyter_client<8" - conda install lumicks.pylake + .. note:: + + There is currently an `open issue `_ with Jupyter that results in communication problems between Jupyter notebooks and the Jupyter kernel. + As a workaround, we temporarily suggest adding the constraint `jupyter_client<8` to install an older version of this kernel. #. You can open a Jupyter notebook in this environment by calling `jupyter notebook` from the terminal. @@ -124,9 +138,16 @@ This concludes the Pylake installation procedure. Check out the :doc:`Tutorial < conda config --add channels conda-forge -#. Install Pylake in this environment by invoking the following command:: +#. Install Pylake in this environment by invoking the following command: + + .. code-block:: + + conda install lumicks.pylake "jupyter_client<8" + + .. note:: - conda install lumicks.pylake + There is currently an `open issue `_ with Jupyter that results in communication problems between Jupyter notebooks and the Jupyter kernel. + As a workaround, we temporarily suggest adding the constraint `jupyter_client<8` to install an older version of this kernel. #. You can open a jupyter notebook in this environment by calling::