Skip to content

Commit

Permalink
docs: update China install FAQ
Browse files Browse the repository at this point in the history
The installation instructions for China did not include the installation for jupyter notebook yet.
  • Loading branch information
aafkevandenberg authored and rpauszek committed Aug 14, 2023
1 parent b3339fa commit 135923a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -444,10 +444,14 @@ If you normally manage your environments with `pip`, you can just invoke::

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple lumicks.pylake

If you use Anaconda, then it is best to create a new environment for this installation. You can do this as follows::
If you use Anaconda, then it is best to create a new environment for this installation. On MacOS an environment is created as follows::

conda create -n pylake_pip

And on Windows an environment is created as::

conda create -n pylake_pip conda=4.9

Activate the environment as follows::

conda activate pylake_pip
Expand All @@ -460,4 +464,8 @@ Then install Pylake as follows::

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple lumicks.pylake

The above line does not include the installation of jupyter notebook. If you want to install jupyter notebook together with Pylake, invoke::

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple lumicks.pylake[notebook]

Important to note is that packages on `conda` and `pip` are typically *not* compatible. Therefore, whenever you use this environment, *only* use pip, and do not install additional dependencies via `conda install`, since this can break your environment.

0 comments on commit 135923a

Please sign in to comment.