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

4
`Documentation <http://www.silx.org/pub/xsocs/doc/>`_
Damien Naudet's avatar
Damien Naudet committed
5 6 7 8 9 10

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

The latest development version can be obtained from the git repository::

Damien Naudet's avatar
Damien Naudet committed
11
    git clone https://gitlab.esrf.fr/kmap/xsocs.git
Damien Naudet's avatar
Damien Naudet committed
12
    cd xsocs
Damien Naudet's avatar
Damien Naudet committed
13 14

And then install::
Damien Naudet's avatar
Damien Naudet committed
15 16
    pip install . [--user]

Damien Naudet's avatar
Damien Naudet committed
17 18
Or, if pip is not available (not recommended):
    python setup.py install [--user]
Damien Naudet's avatar
Damien Naudet committed
19 20 21 22 23 24
    
Starting XSOCS
--------------
At the moment the only way to run XSOCS is from the python interpreter :

**>> python -c 'from xsocs.gui import xsocs_main; xsocs_main()'**
Damien Naudet's avatar
Damien Naudet committed
25

Damien Naudet's avatar
Damien Naudet committed
26 27 28
Dependencies
------------

Damien Naudet's avatar
Damien Naudet committed
29
* `Python <https://www.python.org/>`_ 2.7, 3.4 or 3.5.
Damien Naudet's avatar
Damien Naudet committed
30 31
* `numpy <http://www.numpy.org>`_
* `h5py <http://www.h5py.org/>`_
Damien Naudet's avatar
Damien Naudet committed
32
* `silx <https://pypi.python.org/pypi/silx>`_
33
* `xrayutilities <https://xrayutilities.sourceforge.io/>`_
Damien Naudet's avatar
Damien Naudet committed
34
* A Qt binding: `PyQt5, PyQt4 <https://riverbankcomputing.com/software/pyqt/intro>`_ or `PySide <https://pypi.python.org/pypi/PySide/>`_
Damien Naudet's avatar
Damien Naudet committed
35

Damien Naudet's avatar
Damien Naudet committed
36 37 38
Supported platforms
-------------------
* Linux
Damien Naudet's avatar
Damien Naudet committed
39 40 41

Documentation
-------------
Damien Naudet's avatar
Damien Naudet committed
42
TBD ...
Damien Naudet's avatar
Damien Naudet committed
43 44 45 46

License
-------

Damien Naudet's avatar
Damien Naudet committed
47
The source code of xsocs is licensed under the MIT and LGPL licenses.