summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorPicca Frédéric-Emmanuel <picca@debian.org>2017-11-25 16:55:20 +0100
committerPicca Frédéric-Emmanuel <picca@debian.org>2017-11-25 16:55:20 +0100
commite19c96eff0c310c06c4f268c8b80cb33bd08996f (patch)
treef2b4a365ed899be04766f3937bcc2d58d22be065 /doc/source
parentbfa4dba15485b4192f8bbe13345e9658c97ecf76 (diff)
New upstream version 0.6.1+dfsg
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/index.rst3
-rw-r--r--doc/source/install.rst11
-rw-r--r--doc/source/modules/gui/icons.rst3
-rw-r--r--doc/source/overview.rst5
-rw-r--r--doc/source/sample_code/img/plot3dContextMenu.pngbin0 -> 52128 bytes
-rw-r--r--doc/source/sample_code/index.rst42
6 files changed, 53 insertions, 11 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 86a1395..f1e83b2 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -6,7 +6,8 @@ development of data assessment, reduction and analysis applications at synchrotr
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.
-Silx can be cited by its DOIs referenced on `Zenodo <https://doi.org/10.5281/zenodo.1000472>`_.
+
+Silx can be cited by its DOIs referenced on `Zenodo <https://doi.org/10.5281/zenodo.591709>`_.
The current version provides reading `SPEC <https://certif.com/spec.html>`_ file
format, histogramming, fitting, curves and image plot widget with a set of
diff --git a/doc/source/install.rst b/doc/source/install.rst
index 1bf5b9d..4d8ba5a 100644
--- a/doc/source/install.rst
+++ b/doc/source/install.rst
@@ -2,7 +2,7 @@
Installation steps
==================
-*silx* supports `Python <https://www.python.org/>`_ versions 2.7, 3.4 and 3.5.
+*silx* supports `Python <https://www.python.org/>`_ versions 2.7, 3.4 or later.
To install *silx* on Windows, read the `Windows instructions`_.
@@ -87,6 +87,15 @@ An Arch Linux (AUR) package is also available: https://aur.archlinux.org/package
You can also choose to compile and install *silx* from it's sources:
see `Installing from source`_.
+.. note::
+
+ The Debian packages `python-silx` and `python3-silx` will not install executables (`silx view`, `silx convert` ...).
+ So in order to access those applications you should use: `python* -m silx appX`.
+ For example to open the viewer:
+
+ .. code-block:: python
+
+ python -m silx view
Installing a Debian package
diff --git a/doc/source/modules/gui/icons.rst b/doc/source/modules/gui/icons.rst
index c3fefd8..a1cd3d7 100644
--- a/doc/source/modules/gui/icons.rst
+++ b/doc/source/modules/gui/icons.rst
@@ -57,6 +57,8 @@ Available icons
- cube-left
* - |cube-right|
- cube-right
+ * - |cube-rotate|
+ - cube-rotate
* - |cube-top|
- cube-top
* - |cube|
@@ -287,6 +289,7 @@ Available icons
.. |cube-front| image:: ../../../../silx/resources/gui/icons/cube-front.png
.. |cube-left| image:: ../../../../silx/resources/gui/icons/cube-left.png
.. |cube-right| image:: ../../../../silx/resources/gui/icons/cube-right.png
+.. |cube-rotate| image:: ../../../../silx/resources/gui/icons/cube-rotate.png
.. |cube-top| image:: ../../../../silx/resources/gui/icons/cube-top.png
.. |cube| image:: ../../../../silx/resources/gui/icons/cube.png
.. |document-open| image:: ../../../../silx/resources/gui/icons/document-open.png
diff --git a/doc/source/overview.rst b/doc/source/overview.rst
index f6def11..3cbdd54 100644
--- a/doc/source/overview.rst
+++ b/doc/source/overview.rst
@@ -26,6 +26,11 @@ Project
- `Source repository <https://github.com/silx-kit/silx>`_
- `Issue tracker <https://github.com/silx-kit/silx/issues>`_
- Mailing list: silx@esrf.fr (`Archive <http://www.silx.org/lurker/list/silx.en.html>`_)
+ To register:
+
+ - from inside ESRF use the `sympa web page <http://sympa.esrf.fr>`_,
+ - from outside ESRF, send an email to `silx-subscribe@esrf.fr <mailto:silx-subscribe@esrf.fr>`_.
+
- Continuous integration
- Linux and MacOS X: `Travis <https://travis-ci.org/silx-kit/silx>`_
diff --git a/doc/source/sample_code/img/plot3dContextMenu.png b/doc/source/sample_code/img/plot3dContextMenu.png
new file mode 100644
index 0000000..a01c884
--- /dev/null
+++ b/doc/source/sample_code/img/plot3dContextMenu.png
Binary files differ
diff --git a/doc/source/sample_code/index.rst b/doc/source/sample_code/index.rst
index 6c826b7..a091e58 100644
--- a/doc/source/sample_code/index.rst
+++ b/doc/source/sample_code/index.rst
@@ -59,15 +59,6 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|.
It shows the following widgets:
- :class:WaitingPushButton: A button with a progress-like waiting animated icon
- * - :download:`viewer3DVolume.py <../../../examples/viewer3DVolume.py>`
- - .. image:: img/viewer3DVolume.png
- :height: 150px
- :align: center
- - This script illustrates the use of silx.gui.plot3d.ScalarFieldView.
-
- It loads a 3D scalar data set from a file and displays iso-surfaces and
- an interactive cutting plane.
- It can also be started without providing a file.
:mod:`silx.gui.plot` sample code
++++++++++++++++++++++++++++++++
@@ -120,6 +111,7 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|.
- This script illustrates the addition of a context menu to a PlotWidget.
This is done by adding a custom context menu to the plot area of PlotWidget:
+
- set the context menu policy of the plot area to Qt.CustomContextMenu.
- connect to the plot area customContextMenuRequested signal.
@@ -206,6 +198,38 @@ All sample codes can be downloaded as a zip file: |sample_code_archive|.
- This script is an example to illustrate how to use axis synchronization
tool.
+:mod:`silx.gui.plot3d` sample code
+++++++++++++++++++++++++++++++++++
+
+.. list-table::
+ :widths: 1 1 4
+ :header-rows: 1
+
+ * - Source
+ - Screenshot
+ - Description
+ * - :download:`plot3dContextMenu.py <../../../examples/plot3dContextMenu.py>`
+ - .. image:: img/plot3dContextMenu.png
+ :height: 150px
+ :align: center
+ - This script adds a context menu to a :class:`silx.gui.plot3d.ScalarFieldView`.
+
+ This is done by adding a custom context menu to the :class:`Plot3DWidget`:
+
+ - set the context menu policy to Qt.CustomContextMenu.
+ - connect to the customContextMenuRequested signal.
+
+ For more information on context menus, see Qt documentation.
+ * - :download:`viewer3DVolume.py <../../../examples/viewer3DVolume.py>`
+ - .. image:: img/viewer3DVolume.png
+ :height: 150px
+ :align: center
+ - This script illustrates the use of :class:`silx.gui.plot3d.ScalarFieldView`.
+
+ It loads a 3D scalar data set from a file and displays iso-surfaces and
+ an interactive cutting plane.
+ It can also be started without providing a file.
+
:mod:`silx.io` sample code
++++++++++++++++++++++++++