Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add specific jupyter client to instructions #467

Merged
merged 1 commit into from
Mar 9, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/jupyter/notebook/issues/6748>`_ 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::

Expand Down Expand Up @@ -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 <https://github.com/jupyter/notebook/issues/6748>`_ 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.

Expand Down Expand Up @@ -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 <https://github.com/jupyter/notebook/issues/6748>`_ 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::

Expand Down