From ab6a2b607e3d7628c95a439c612571d12c33c9fd Mon Sep 17 00:00:00 2001 From: Neil Vaytet Date: Wed, 16 Aug 2023 14:46:41 +0200 Subject: [PATCH] add missing index --- docs/index.rst | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 docs/index.rst diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..72193578 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,66 @@ +.. raw:: html + +
+ +
+ + +.. role:: transparent + +:transparent:`Plopp` +******************** + +**Plopp** is the new data visualization framework for the `Scipp `_ project. + +Installation +============ + +Using pip +--------- + +You can install from ``pip`` using + +.. code-block:: sh + + pip install plopp[scipp] + +This will install both ``plopp`` and ``scipp`` which is required to use ``plopp``. +If you already have ``scipp`` installed, you can leave the ``[scipp]`` part out: + +.. code-block:: sh + + pip install plopp + +By default, this will only install minimal requirements which will allow you to create +static 1d and 2d plots. +If you wish to use additional features (interactive figures and 3d rendering), +you can install all the optional dependencies by doing + +.. code-block:: sh + + pip install plopp[all] + +Using conda +----------- + +You can install from ``conda`` using + +.. code-block:: sh + + conda install -c conda-forge -c scipp plopp + +Get in touch +============ + +- If you have questions that are not answered by these documentation pages, ask on `GitHub discussions `_. + Please include a self-contained reproducible example if possible. +- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code `on GitHub `_. + +.. toctree:: + :hidden: + + getting-started/index + basics/index + customization/index + examples/index + about/index