From a2e8a4ef463eef3d1befc5467558608ea494f519 Mon Sep 17 00:00:00 2001
From: Ali Aghaeifar <ali.aghaeifar@tuebingen.mpg.de>
Date: Fri, 12 Jul 2024 08:05:53 +0200
Subject: [PATCH] .

---
 docs/source/conf.py          | 15 +++++++++++
 docs/source/file format.rst  |  2 ++
 docs/source/index.rst        | 14 ++++------
 docs/source/installation.rst | 50 ++++++++++++++++++++++++++++++++++++
 docs/source/tutorial.rst     |  2 ++
 5 files changed, 74 insertions(+), 9 deletions(-)
 create mode 100644 docs/source/file format.rst
 create mode 100644 docs/source/installation.rst
 create mode 100644 docs/source/tutorial.rst

diff --git a/docs/source/conf.py b/docs/source/conf.py
index c037d31..b2c724f 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -26,3 +26,18 @@
 
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+
+
+html_logo = "_static/logo.png"
+
+
+# Specify master doc so build at read the docs won't fail
+master_doc = "index"
+
+# Syntax highlighting
+pygments_style = "stata-light"
+pygments_dark_style = "stata-dark"
+
+autodoc_default_options = {
+    "imported-members": True,
+}
\ No newline at end of file
diff --git a/docs/source/file format.rst b/docs/source/file format.rst
new file mode 100644
index 0000000..ba4f526
--- /dev/null
+++ b/docs/source/file format.rst	
@@ -0,0 +1,2 @@
+File Format
+***********
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index ddc03f5..bd68d72 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -9,12 +9,8 @@ Welcome to SpinWalk's documentation!
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   
+   installation
+   tutorial
+   file format
+   View on GitHub <https://github.com/aghaeifar/SpinWalk>
\ No newline at end of file
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
new file mode 100644
index 0000000..1366050
--- /dev/null
+++ b/docs/source/installation.rst
@@ -0,0 +1,50 @@
+###############
+Installation
+###############
+
+
+***************
+How to build
+***************
+
+You can either use the supplied Dockerfile for a consistent build that includes all dependencies, or install the dependencies separately and compile using CMake.
+
+Docker
+===============
+
+We suggest utilizing the provided Dockerfile, which automates the installation of all dependencies, as well as the cloning and building of the program. Download the Dockerfile to your current directory and then execute the following commands:
+
+
+In almost any documentation you need to show examples like:
+
+
+.. code-block:: bash
+
+	docker build --no-cache -t spinwalk .
+	docker run --gpus all --rm -it --runtime=nvidia spinwalk bash
+
+CMake
+===============
+
+Dependencies
+---------------
+* A C++ compiler supprting C++ 20
+* CUDA driver (nvidia-smi and nvcc --version must run in terminal)
+* Boost libraries (+)
+* HDF5 Library (+)
+* Threading Building Blocks (TBB).
+
+If you prefer to install the program without using Docker, follow these steps (tested in Ubuntu 22.04):
+
+.. code-block:: bash
+
+    sudo apt-get update && apt-get install -y libboost-all-dev libhdf5-dev libtbb-dev
+    git clone https://github.com/aghaeifar/SpinWalk.git
+    cd SpinWalk
+    cmake -B ./build
+    cmake --build ./build --config Release
+    
+**********************  
+Quick test after build
+**********************
+After building the program, simply launch ``spinwalk`` in the terminal to view the help menu with all available options. At the end of the output, the detected GPUs and driver must be displayed.
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
new file mode 100644
index 0000000..f581052
--- /dev/null
+++ b/docs/source/tutorial.rst
@@ -0,0 +1,2 @@
+Tutorial
+*********
\ No newline at end of file