From 9c7aa7bc5be36752015f829fabe7488d26f9bb41 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Madon?= <mael.madon@irit.fr>
Date: Tue, 18 Jun 2024 17:38:55 +0200
Subject: [PATCH] doc: moved general description to readthedoc
---
docs/conf.py | 4 ++--
docs/dev/documentation.md | 2 +-
docs/index.rst | 27 +++++++++++++++++++++++++++
3 files changed, 30 insertions(+), 3 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index 543b7bd..05b488b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -7,8 +7,8 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Batmen'
-copyright = '2024, Maël Madon, Millian Poquet, Jolyne Gatt'
-author = 'Maël Madon, Millian Poquet, Jolyne Gatt'
+copyright = '2024, Maël Madon'
+author = 'Maël Madon'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md
index aebdfb8..db9aa3e 100644
--- a/docs/dev/documentation.md
+++ b/docs/dev/documentation.md
@@ -1,4 +1,4 @@
-## Build the documentation
+# Build the documentation
The present documentation is located in the folder `docs` and hosted on [readthedocs](https://batmen.readthedocs.io/en/latest/).
It is automatically built and updated whenever there is a push on Batmen's `master` branch.
diff --git a/docs/index.rst b/docs/index.rst
index 4fe3ec3..222bb20 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,6 +6,33 @@
Welcome to Batmen's documentation!
==================================
+Batmen is a plugin to the scientific simulator `Batsim <https://batsim.org/>`_.
+It allows the simulation of **users** (bat-men) of large-scale distributed systems.
+
+How does is work?
+-----------------
+
+.. image:: ../batmen_diagram.svg
+ :alt: Batmen diagram
+
+A simulation with Batmen has to be launched in parallel with Batsim.
+
+* Batsim takes care of **simulating the IT platform** (job arrival, job termination, energy consumed...), thanks to the underlying simulator `SimGrid <https://simgrid.org/>`_.
+* Batmen simulates the **users of the system**, through their **job submission behavior**. It also simulates the **scheduler**.
+
+Batmen was developped mainly by Maël Madon during his PhD thesis.
+The most up-to-date description can be found in Chapter II of the thesis manuscript (and more precisely in Section II.2.2).
+It was used to carry scientific experimental campains, leading to several peer-reveiwed publications:
+
+* `Europar'22 <https://doi.org/10.1007/978-3-031-12597-3_4>`_: Maël Madon, Georges Da Costa, and Jean-Marc Pierson. *"Characterization of Different User Behaviors for Demand Response in Data Centers"*
+* `FGCS'24 <https://doi.org/10.1016/j.future.2024.01.024>`_: Maël Madon, Georges Da Costa, and Jean-Marc Pierson. *"Replay with Feedback: How Does the Performance of HPC System Impact User Submission Behavior?"*
+* ICT4S'24: Jolyne Gatt, Maël Madon, and Georges Da Costa. *"Digital Sufficiency Behaviors to Deal with Intermittent Energy Sources in a Data Center"*
+
+If you use it for your work, please cite one of these.
+
+This documentation is divided in two parts, user and developer manual:
+
+
.. toctree::
:maxdepth: 1
:caption: User manual:
--
GitLab