diff options
Diffstat (limited to 'doc/source/applications')
-rw-r--r-- | doc/source/applications/compare.rst | 40 | ||||
-rw-r--r-- | doc/source/applications/img/silx-compare.png | bin | 0 -> 424032 bytes | |||
-rw-r--r-- | doc/source/applications/index.rst | 6 | ||||
-rw-r--r-- | doc/source/applications/view.rst | 51 |
4 files changed, 89 insertions, 8 deletions
diff --git a/doc/source/applications/compare.rst b/doc/source/applications/compare.rst new file mode 100644 index 0000000..4175eae --- /dev/null +++ b/doc/source/applications/compare.rst @@ -0,0 +1,40 @@ +.. _silx compare: + +silx compare +============ + +Purpose +------- + +The *silx compare* command provides a graphical user interface to compare 2D data from files. + +It displays a list of datasets, and allows to open multiple datasets. +This list can be updated with drag and drop from silx view. + + +.. |imgViewImg| image:: img/silx-compare.png + :height: 300px + :align: middle + + +Usage +----- + +:: + + silx compare [-h] [--debug] [--use-opengl-plot] [files [files ...]] + + +Options +------- + + -h, --help show this help message and exit + --debug Set logging system in debug mode + --use-opengl-plot Use OpenGL for plots (instead of matplotlib) + +Examples of usage +----------------- + +:: + + silx compare "silx://ID16B_diatomee.h5?path=/scan1/instrument/data&slice=0" "silx://ID16B_diatomee.h5?path=/scan1/instrument/data&slice=1" diff --git a/doc/source/applications/img/silx-compare.png b/doc/source/applications/img/silx-compare.png Binary files differnew file mode 100644 index 0000000..bbd2117 --- /dev/null +++ b/doc/source/applications/img/silx-compare.png diff --git a/doc/source/applications/index.rst b/doc/source/applications/index.rst index 2601e2c..fd3552a 100644 --- a/doc/source/applications/index.rst +++ b/doc/source/applications/index.rst @@ -1,6 +1,7 @@ +.. _Applications: -Applications documentation -========================== +Applications +============ While *silx* is first and foremost a Python library to be used by developers, a set of command line applications is provided to use some key features of @@ -15,3 +16,4 @@ To see the list of all available commands, type the following command in a termi view convert + compare diff --git a/doc/source/applications/view.rst b/doc/source/applications/view.rst index 694f95d..05e38b9 100644 --- a/doc/source/applications/view.rst +++ b/doc/source/applications/view.rst @@ -1,7 +1,11 @@ +.. _silx view: silx view ========= +.. figure:: http://www.silx.org/doc/silx/img/silx-view-v1-0.gif + :align: center + Purpose ------- @@ -37,24 +41,59 @@ and to view this data in plot widgets or in simple table views. Usage ----- -:: +.. code-block:: none - silx view [-h] [--debug] [--use-opengl-plot] [files [files ...]] + silx view [-h] [--slices SLICES [SLICES ...]] [--debug] [--use-opengl-plot] [-f] [--hdf5-file-locking] [files ...] Options ------- - -h, --help Show this help message and exit - --debug Set logging system in debug mode - --use-opengl-plot Use OpenGL for plots (instead of matplotlib) +.. code-block:: none + -h, --help show this help message and exit + --slices SLICES [SLICES ...] + List of slice indices to open (Only for dataset) + --debug Set logging system in debug mode + --use-opengl-plot Use OpenGL for plots (instead of matplotlib) + -f, --fresh Start the application using new fresh user preferences + --hdf5-file-locking Start the application with HDF5 file locking enabled (it is disabled by + default) Examples of usage ----------------- -:: +Open file(s) +............ + +.. code-block:: none silx view 31oct98.dat silx view *.edf silx view myfile.h5 + + +Open HDF5 dataset(s) +.................... + +Using the HDF5 path to the dataset: + +.. code-block:: none + + silx view my_hdf5_file.h5::entry/instrument/detector/data + +Using wildcard: + +.. code-block:: none + + silx view my_hdf5_file.h5::entry/*/data + + +Open HDF5 dataset slices +........................ + +Open first and last slices of datasets: + +.. code-block:: none + + silx view my_hdf5_file.h5::entry/*/data --slices 0 -1 |