diff options
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 39 |
1 files changed, 31 insertions, 8 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index f1e83b2..0a44784 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,16 +2,35 @@ silx |version| ============== The silx project aims at providing a collection of Python packages to support the -development of data assessment, reduction and analysis applications at synchrotron -radiation facilities. -It aims at providing reading/writing different file formats, data reduction routines -and a set of Qt widgets to browse and visualize data. +development of data assessment, reduction and analysis at synchrotron radiation +facilities. +It intends to provide reading/writing tools for different file formats, data +reduction routines and a set of Qt widgets to browse and visualise data. +Silx can be cited by its DOIs referenced on +`Zenodo <https://doi.org/10.5281/zenodo.591709>`_. -Silx can be cited by its DOIs referenced on `Zenodo <https://doi.org/10.5281/zenodo.591709>`_. +The current version (v0.7) caters for: + +* Supporting `HDF5 <https://www.hdfgroup.org/HDF5/>`_, + `SPEC <https://certif.com/spec.html>`_ and + `FabIO <http://www.silx.org/doc/fabio/dev/getting_started.html#list-of-file-formats-that-fabio-can-read-and-write>`_ + images file formats. +* OpenCL-based data processing: image alignment (SIFT), + image processing (median filter, histogram), + filtered backprojection for tomography +* Data reduction: histogramming, fitting, median filter +* A set of Qt widgets, including: + + * 1D and 2D visualization widgets with a set of associated tools using multiple backends (matplotlib or OpenGL) + * OpenGL-based widgets to visualize data in 3D (scalar field with isosurface and cut plane, scatter plot) + * a unified browser for HDF5, SPEC and image file formats supporting inspection and + visualization of n-dimensional datasets. + +* a set of applications: + + * a unified viewer (*silx view filename*) for HDF5, SPEC and image file formats + * a unified converter to HDF5 format (*silx convert filename*) -The current version provides reading `SPEC <https://certif.com/spec.html>`_ file -format, histogramming, fitting, curves and image plot widget with a set of -associated tools. .. toctree:: :hidden: @@ -21,6 +40,7 @@ associated tools. description/index.rst tutorials.rst modules/index.rst + applications/index.rst changelog.rst license.rst virtualenv.rst @@ -40,6 +60,9 @@ associated tools. :doc:`modules/index` Documentation of the packages included in *silx* +:doc:`applications/index` + Documentation of the applications provided by *silx* + :doc:`modules/gui/gallery` Widgets gallery and screenshots |