README.rst 1.06 KB
Newer Older
Damien Naudet's avatar
Damien Naudet committed
1
xsocs
Damien Naudet's avatar
Damien Naudet committed
2 3 4 5 6 7 8 9 10
====

TBD

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 19
Or, if pip is not available (not recommended):
    python setup.py install [--user]

Damien Naudet's avatar
Damien Naudet committed
20 21 22 23 24 25
Dependencies
------------

* `Python <https://www.python.org/>`_ 2.7, 3.4 and 3.5.
* `numpy <http://www.numpy.org>`_
* `h5py <http://www.h5py.org/>`_
Damien Naudet's avatar
Damien Naudet committed
26
* `silx <https://pypi.python.org/pypi/silx>`_
Damien Naudet's avatar
Damien Naudet committed
27
* 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
28

29
Supported platforms: Linux
Damien Naudet's avatar
Damien Naudet committed
30 31 32 33

Documentation
-------------

34 35
..
    To build the documentation from the source (requires `Sphinx <http://www.sphinx-doc.org>`_), run::
Damien Naudet's avatar
Damien Naudet committed
36 37

    python setup.py build build_doc
38
..
Damien Naudet's avatar
Damien Naudet committed
39 40
Testing
-------
41 42
..
    |Travis Status| |Appveyor Status|
Damien Naudet's avatar
Damien Naudet committed
43

44
    To run the tests, from the source directory, run::
Damien Naudet's avatar
Damien Naudet committed
45

46 47
        python run_tests.py
..
Damien Naudet's avatar
Damien Naudet committed
48 49 50
License
-------

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