From 376d7768a5c226e6859bcd21deb3c521de368495 Mon Sep 17 00:00:00 2001 From: Gabriel Gerez Date: Wed, 5 Jun 2024 09:11:34 +0200 Subject: [PATCH] initial structuring of installation instructions --- docs/index.rst | 2 +- docs/installation.rst | 26 ++++++++++++++++++++++++++ docs/usage.rst | 12 ------------ 3 files changed, 27 insertions(+), 13 deletions(-) create mode 100644 docs/installation.rst delete mode 100644 docs/usage.rst diff --git a/docs/index.rst b/docs/index.rst index d7a37096..67fc4ff2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,7 +18,7 @@ Check out the :doc:`usage` section for further information, including how to :re :maxdepth: 2 :caption: Contents - usage + installation notebooks/introduction notebooks/function_representations notebooks/multiwavelets diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 00000000..a2337e6a --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,26 @@ +.. _installation: +============ +Installation +============ + + +Prerequisites +============= + + +Install options +=============== + +From conda +---------- + +The easiest way to install **VAMPyR** is to use the conda package manager. +You can install **VAMPyR** by running: + +From source +----------- + +Here we need to write about how to install **VAMPyR**. Possibilities: +conda package, build from source, .... + + diff --git a/docs/usage.rst b/docs/usage.rst deleted file mode 100644 index 304a46b9..00000000 --- a/docs/usage.rst +++ /dev/null @@ -1,12 +0,0 @@ -Usage -===== - -.. _installation: - -Installation ------------- - -Here we need to write about how to install **VAMPyR**. Possibilities: -conda package, build from source, .... - -