README.rst 974 Bytes
Newer Older
Damien Naudet's avatar
Damien Naudet committed
1
xsocs
2
=====
Damien Naudet's avatar
Damien Naudet committed
3

4 5 6 7 8
The X-ray Strain Orientation Calculation Software (X-SOCS) is a user-friendly software,
developed for automatic analysis of 5D sets of data recorded during continuous mapping measurements.
X-SOCS aims at retrieving strain and tilt maps of nanostructures, films, surfaces or even embedded structures.

`Documentation <http://kmap.gitlab-pages.esrf.fr/xsocs>`_
Damien Naudet's avatar
Damien Naudet committed
9 10 11 12

Installation
------------

13
X-SOCS runs on Linux and Windows with `Python <https://www.python.org/>`_ >=3.4.
Damien Naudet's avatar
Damien Naudet committed
14

15
See `How to install XSocs <http://kmap.gitlab-pages.esrf.fr/xsocs/install.html>`_ for details and dependencies.
Thomas Vincent's avatar
Thomas Vincent committed
16

17 18
Using XSOCS
------------
Damien Naudet's avatar
Damien Naudet committed
19

20
Once installed, you can run X-SOCS from the console with either::
Thomas Vincent's avatar
Thomas Vincent committed
21 22 23

    xsocs

24 25 26 27
Or::

    python -m xsocs

28 29
See `Using X-Socs documentation <http://kmap.gitlab-pages.esrf.fr/xsocs/using.html>`_ and
the `video tutorials <http://kmap.gitlab-pages.esrf.fr/xsocs/tutorials.html>`_.
Damien Naudet's avatar
Damien Naudet committed
30 31 32 33

License
-------

34
The source code of xsocs is licensed under the MIT license.