Skip to content
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
44 changes: 43 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
Installation
------------
============


To install the latest version of the library, you can simply run:

.. code-block:: bash

pip install neo4j-viz


Optional dependencies
---------------------

In addition, there are a few optional dependencies that you can install to enable additional features of the library.


Pandas `from_dfs` importer
~~~~~~~~~~~~~~~~~~~~~~~~~~

To install the additional dependencies required for the :doc:`from_dfs importer <./api-reference/from_pandas>` you can run:

.. code-block:: bash

pip install neo4j-viz[pandas]


Neo4j Graph Data Science `from_gds` importer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To install the additional dependencies required for the :doc:`from_gds importer <./api-reference/from_gds>` you can run:

.. code-block:: bash

pip install neo4j-viz[gds]

Notebook tutorials
~~~~~~~~~~~~~~~~~~

To install all the additional dependencies required for the :doc:`notebook examples <./tutorials/index>` you can run:

.. code-block:: bash

pip install neo4j-viz[notebook]
Loading