Commit 316651aa authored by Thomas Vincent's avatar Thomas Vincent

Simplify README to point to doc (avoid duplicates)

parent fb409f80
xsocs
====
=====
`Documentation <http://www.silx.org/pub/xsocs/doc/>`_
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>`_
Installation
------------
The latest development version can be obtained from the git repository::
git clone https://gitlab.esrf.fr/kmap/xsocs.git
cd xsocs
And then install::
pip install . [--user]
X-SOCS runs on Linux with `Python <https://www.python.org/>`_ >=3.4 or 2.7.
Or, if pip is not available (not recommended)::
See `How to install XSocs <http://kmap.gitlab-pages.esrf.fr/xsocs/install.html>`_ for details and dependencies.
python setup.py install [--user]
Starting XSOCS
--------------
Using XSOCS
------------
Once installed, you can run XSOCS from the console with either::
Once installed, you can run X-SOCS from the console with either::
xsocs
......@@ -30,34 +25,8 @@ Or::
python -m xsocs
Or from the python interpreter:
>>> from xsocs.gui import xsocs_main
>>> xsocs_main()
Dependencies
------------
* `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>`_
Supported platforms
-------------------
* Linux
Documentation
-------------
See `Documentation <http://www.silx.org/pub/xsocs/doc/>`_.
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>`_.
License
-------
......
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