Commit 2cf809fa authored by Thomas Vincent's avatar Thomas Vincent
Browse files

Update doc

parent 55db940d
......@@ -22,12 +22,11 @@ films, surfaces or even embedded structures.
How to use *X-SOCS* to reduce KMAP data
:doc:`tutorials`
Tutorials
Video tutorials
Project Resources:
- `Source code repository <https://gitlab.esrf.fr/kmap/xsocs>`_
- `Issue tracker <https://gitlab.esrf.fr/kmap/xsocs/issues>`_
Project Resources
- `Source code repository <https://gitlab.esrf.fr/kmap/xsocs>`_
- `Issue tracker <https://gitlab.esrf.fr/kmap/xsocs/issues>`_
Indices and tables
==================
......
......@@ -2,7 +2,7 @@
Installation
============
*X-SOCS* supports `Python <https://www.python.org/>`_ versions 2.7, 3.4 and 3.5.
*X-SOCS* supports `Python <https://www.python.org/>`_ versions >= 3.4 (recommended) and 2.7.
At the moment *X-SOCS* can only be installed from the source, see `Installing from source`_.
......@@ -11,26 +11,25 @@ Dependencies
The dependencies of *X-SOCS* are:
* `silx <http://pythonhosted.org/silx/install.html>`_ and its `optional dependencies <http://pythonhosted.org/silx/install.html#dependencies>`_:
* `matplotlib <http://matplotlib.org/>`_
* `h5py <http://docs.h5py.org/en/latest/build.html>`_ for HDF5 files
* A Qt binding: either `PyQt5 or PyQt4 <https://riverbankcomputing.com/software/pyqt/intro>`_
* `PyOpenGL <http://pyopengl.sourceforge.net/>`_
* `xrayutilities <https://xrayutilities.sourceforge.io/>`_.
* `scipy <https://pypi.python.org/pypi/scipy>`_.
* `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>`_
* `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>`_
In addition, OpenGL 2.1 is required for the 3D view of the QSpace.
Build dependencies
++++++++++++++++++
The build dependencies for *X-SOCS* are the same as the ones for `silx <http://pythonhosted.org/silx/install.html#build-dependencies>`_::
In addition to run-time dependencies, building *silx* requires a C/C++ compiler, numpy and cython (optional).
On Windows it is recommended to use Python 3.5, because with previous versions of Python, it might be difficult to compile the extensions.
In addition to run-time dependencies, building *X-SOCS* requires:
This project uses cython to generate C files.
Cython is not mandatory to build *silx* and is only needed when developing binary modules.
If using cython, *silx* requires at least version 0.18 (with memory-view support).
* a C/C++ compiler
* `cython <http://cython.org/>`_ (>=0.21).
Installing from source
----------------------
......
Correcting for sample shift
===========================
\ No newline at end of file
......@@ -2,16 +2,19 @@
Starting X-SOCS
===============
X-SOCS can be started from the command line::
Once installed, you can run XSOCS from the console with either::
xsocs
Or::
python -m xsocs
Or from the Python console:
Or from the python interpreter:
.. code-block:: python
>>> from xsocs.gui import xsocs_main
>>> xsocs_main()
from xsocs.gui import xsocs_main
xsocs_main()
This will open X-SOCS main window, with no project loaded.
......
Supports Markdown
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