Skip to content

Commit

Permalink
docs: Improve installation.rst
Browse files Browse the repository at this point in the history
* Add installation command for installing with extras using `pip`.
* Add section on how to render Plotly interactive plots in Visual Studio Code.
  • Loading branch information
mbelak-dtml committed Jul 25, 2023
1 parent 8b29829 commit 1d17a0b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ or you can add edvart into your environment file defined by `pyproject.toml`:
edvart = "|VERSION|"
Extras
------

edvart also has an optional dependency "umap", which adds a plot called UMAP
(Universal Manifold Approximation) to Multivariate Analysis. To install edvart with the optional
extra, replace the above snippet of the `pyproject.toml` environment file with the following
Expand All @@ -28,6 +31,18 @@ snippet:
python = ">=3.8, <3.12"
edvart = { version = "|VERSION|", extras = ["umap"] }
To install edvart with the optional "umap" dependencyvia pip, run the following command:

.. code-block:: console
$ pip install "edvart[umap]"
Plotly
======

JupyterLab
----------

To display interactive plots which use Plotly in JupyterLab, you need to install some JupyterLab
extensions.
Expand All @@ -42,3 +57,14 @@ https://plot.ly/python/getting-started/ or simply run the following commands
jupyter labextension install [email protected] --no-build
jupyter labextension install [email protected] --no-build
jupyter lab build
Visual Studio Code
------------------
To display interactive plots which use Plotly in Visual Studio Code notebooks,
you need to install the following extensions:

* `Jupyter <https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter>`_ is required to
run Jupyter notebooks in Visual Studio Code.
* `Jupyter Notebook Renderers <https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter-renderers>`_ is required
to render Plotly plots in Visual Studio Code notebooks.

0 comments on commit 1d17a0b

Please sign in to comment.