Commit 8d36a37b authored by Thomas Vincent's avatar Thomas Vincent

update documentation main pages

parent f95d595d
......@@ -17,7 +17,7 @@ films, surfaces or even embedded structures.
troubleshooting.rst
:doc:`install`
How to install *X-SOCS* on Linux
How to install *X-SOCS*
:doc:`using`
How to use *X-SOCS* to reduce KMAP data
......@@ -28,9 +28,10 @@ films, surfaces or even embedded structures.
:doc:`troubleshooting`
When things do not work as expected
Project Resources
- `Source code repository <https://gitlab.esrf.fr/kmap/xsocs>`_
- `Issue tracker <https://gitlab.esrf.fr/kmap/xsocs/issues>`_
Resources:
- `Source code repository <https://gitlab.esrf.fr/kmap/xsocs>`_
- `Issue tracker <https://gitlab.esrf.fr/kmap/xsocs/issues>`_
Indices and tables
==================
......
......@@ -14,12 +14,14 @@ The dependencies of *X-SOCS* are:
* `Python <https://www.python.org/>`_ >=3.4 or 2.7 (Note: The Graphical user interface is only tested with python3).
* `numpy <http://www.numpy.org>`_
* `h5py <http://www.h5py.org/>`_
* `silx <https://pypi.python.org/pypi/silx>`_
* `fabio <https://pypi.org/project/fabio/>`_
* `silx <https://pypi.org/project/silx>`_
* `xrayutilities <https://xrayutilities.sourceforge.io/>`_
* `scipy <https://pypi.python.org/pypi/scipy>`_
* `PyOpenGL <http://pyopengl.sourceforge.net/>`_
* `matplotlib <https://matplotlib.org/>`_
* `PyQt5 <https://riverbankcomputing.com/software/pyqt/intro>`_
* `setuptools <https://pypi.org/project/setuptools/>`_
In addition, OpenGL 2.1 is required for the 3D view of the QSpace.
......@@ -54,4 +56,3 @@ And install xsocs, either system-wide (requires root privileges)::
or for the current user only::
pip install . --user
......@@ -4,13 +4,8 @@ Trouble shooting
Using XSocs through ssh
-----------------------
XSocs is using OpenGL2.1 for QSpace visualization.
When running through ssh, there are a few reasons that can avoid the display of the 3D QSpace visualization:
XSocs is using OpenGL 2.1 widgets from the `silx <http://www.silx.org/doc/silx/latest/>`_ toolkit for QSpace visualization.
When running through ssh, there are a few reasons that can avoid the display of the 3D QSpace visualization.
See `Using OpenGL through ssh <http://www.silx.org/doc/silx/latest/troubleshooting.html#using-opengl-through-ssh>`_ in `silx <http://www.silx.org/doc/silx/latest/>`_ documentation for more information.
- Make sure to use ``ssh -X`` to enable X11 forwarding.
- Both server and client computers must have the same kind of GPU drivers
(either both using proprietary NVidia drivers or both using open source drivers),
otherwise only OpenGL1.4 is available.
- "Indirect GLX" must be enabled on the local computer.
This can be set in the configuration of the display manager or the X server (requires root access).
On Debian 8, for kdm, add ``+iglx`` after ``ServerArgsLocal=...`` in ``/etc/kde4/kdm/kdmrc`` and restart the x server.
\ No newline at end of file
......@@ -30,3 +30,8 @@ Video tutorials
`Part 10: Q workspace Bragg peak fitting or COM <https://www.youtube.com/watch?v=eShYxO1ZF10>`_
`Part 11: Results workspace <https://www.youtube.com/watch?v=JbO9U7d-hPs>`_
.. note::
Since video tutorials were made, the graphical user interface has changed.
Yet the procedure remains valid.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment