adding introduction to the documentation

a-rouxel · Nov 6, 2023 · be9c8b1 · be9c8b1
1 parent 0cae8a7
commit be9c8b1
Show file tree

Hide file tree

Showing 7 changed files with 1,501 additions and 2 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -3,8 +3,41 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to beamshapy's documentation!
-=====================================
+beamshapy : laser beam shaping simulations
+==========================================
+.. image:: ./resources/logo.png
+
+beamshapy is a python-based tool that performs optical simulations for laser beam shaping.
+We provide a package and a graphical user interface developed in PyQt5.
+
+It is built upon the LightPipes toolbox and provides various methods for generating custom intensity and amplitude profiles with Spatial Light modulators (SLM).
+
+Available **optical system architectures** are:
+
+- Single fourier transform with phase modulation
+.. image:: ./resources/simple-shaper.png
+- 4f fourier tranform with phase modulation and spatial filtering
+
+Available amplitude/intensity profiles **generation methods** are:
+
+- Weighted Gerchberg-Saxton algorithm
+- Amplitude modulation of blazed gratings
+
+
+Main Features
+=============
+
+beamshapy offers 3 main features :
+
+- **Target Amplitude/Intensity design**: for specifying objective output field characteristics
+- **Phase mask design**: for generating or designing SLM phase masks
+- **Optical propagation**: for evaluating resulting output field
+
+For more detailed information about each feature and further instructions, please visit our documentation.
+
+
+
+
 
 .. toctree::
    :maxdepth: 2

diff --git a/doc/resources/log_tests.svg b/doc/resources/log_tests.svg
diff --git a/doc/resources/logo.png b/doc/resources/logo.png
diff --git a/doc/resources/logo_beam_shaper.png b/doc/resources/logo_beam_shaper.png
diff --git a/doc/resources/simple-shaper.pdf b/doc/resources/simple-shaper.pdf
diff --git a/doc/resources/simple-shaper.png b/doc/resources/simple-shaper.png
diff --git a/doc/resources/simple_setup.svg b/doc/resources/simple_setup.svg