diff options
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..656f774 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,47 @@ +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. + +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: + + overview.rst + install.rst + description/index.rst + tutorials.rst + modules/index.rst + changelog.rst + license.rst + virtualenv.rst + +:doc:`overview` + Releases, repository, issue tracker, mailing list, ... + +:doc:`install` + How to install *silx* on Linux, Windows and MacOS X + +:doc:`description/index` + Description of the different algorithms and their implementation + +:doc:`tutorials` + Tutorials and sample code + +:doc:`modules/index` + Documentation of the packages included in *silx* + +:doc:`changelog` + List of changes between releases + +:doc:`license` + License and copyright information + +Indices +======= + +* :ref:`modindex` +* :ref:`search` +* :ref:`genindex` |