diff options
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 166 |
1 files changed, 104 insertions, 62 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 027bd6f..d7e99cd 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,91 +1,133 @@ silx |version| ============== -.. |silxView| image:: http://www.silx.org/doc/silx/img/silx-view-v1-0.gif - :height: 80px +.. toctree:: + :hidden: + + user_guide.rst + applications/index.rst + tutorials.rst + modules/index.rst + changelog.rst -The silx project aims to provide a collection of Python packages to support the +silx provides applications and Python modules to support the development of data assessment, reduction and analysis at synchrotron radiation facilities. -It intends to provide reading/writing tools for different file formats, data +It provides 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>`_. -The current version (v\ |version|) caters for: +:ref:`Installation` +------------------- -* 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: +You can install **silx** via `pip <https://pypi.org/project/pip>`_, `conda <https://docs.conda.io>`_ or on Linux with the following commands: - * 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. +.. tabbed:: pip -* a set of applications: + .. code-block:: bash - * a unified viewer (:ref:`silx view` *filename*) for HDF5, SPEC and image file formats + pip install silx[full] - |silxView| +.. tabbed:: conda - * a unified converter to HDF5 format (*silx convert filename*) + .. code-block:: bash - + conda install -c conda-forge silx -.. toctree:: - :hidden: +.. tabbed:: Debian & Ubuntu - overview.rst - install.rst - description/index.rst - tutorials.rst - modules/index.rst - applications/index.rst - changelog.rst - license.rst - virtualenv.rst - troubleshooting.rst + .. code-block:: bash + + sudo apt-get install silx + +|silx_installer_btn| or decompress the |silx_archive|. + +:ref:`Applications` +------------------- + +.. panels:: + + :column: col-lg-12 + :body: text-center + + **silx view** + ^^^^^^^^^^^^^ + + .. image:: img/silx-view.gif + + .. link-button:: applications/view + :type: ref + :text: Unified viewer supporting HDF5, SPEC and image file formats + :classes: stretched-link + + --- + + **silx compare** + ^^^^^^^^^^^^^^^^ + + .. image:: applications/img/silx-compare.png + + .. link-button:: applications/compare + :type: ref + :text: User interface to compare 2D data from files + :classes: stretched-link + + --- + + **silx convert** + ^^^^^^^^^^^^^^^^ + + .. link-button:: applications/convert + :type: ref + :text: Converter of legacy file formats into HDF5 file + :classes: stretched-link + +:ref:`Python modules<API Reference>` +------------------------------------ + +.. panels:: + + **silx.gui** + ^^^^^^^^^^^^ -:doc:`overview` - Releases, repository, issue tracker, mailing list, ... + .. link-button:: modules/gui/index + :type: ref + :text: Qt widgets: + :classes: stretched-link -:doc:`install` - How to install *silx* on Linux, Windows and MacOS X + * 1D and 2D visualization widgets and associated tools + * OpenGL-based 3D visualization widgets + * a unified HDF5, SPEC and image data file browser and n-dimensional dataset viewer -:doc:`description/index` - Description of the different algorithms and their implementation + --- -:doc:`tutorials` - Tutorials and sample code + **silx.opencl** + ^^^^^^^^^^^^^^^ -:doc:`modules/index` - Documentation of the packages included in *silx* + .. link-button:: modules/opencl/index + :type: ref + :text: OpenCL-based data processing: + :classes: stretched-link -:doc:`applications/index` - Documentation of the applications provided by *silx* + * Image alignment (SIFT) + * Image processing (median filter, histogram) + * Filtered backprojection for tomography -:doc:`modules/gui/gallery` - Widgets gallery and screenshots + --- -:doc:`changelog` - List of changes between releases + **silx.io** + ^^^^^^^^^^^ -:doc:`license` - License and copyright information + .. link-button:: modules/io/index + :type: ref + :text: Supporting HDF5, SPEC and FabIO images file formats + :classes: stretched-link -:doc:`troubleshooting` - When things do not work as expected + --- -Indices -======= + **silx.math** + ^^^^^^^^^^^^^ -* :ref:`modindex` -* :ref:`search` -* :ref:`genindex` + .. link-button:: modules/math/index + :type: ref + :text: Data reduction: histogramming, fitting, median filter + :classes: stretched-link |