Commit 8b953ae6 authored by Unknown's avatar Unknown
Browse files

Reorganized examples and build new documentation

parent 71c61a07
......@@ -122,7 +122,7 @@ dataset would be structured as:
+------------+------------+------------+--------+--------------+--------------+
| i0, j0 | i0, j1 | i0, j2 | .... | i0, jP-2 | i0, jP-1 |
+============+============+============+========+==============+==============+
+------------+------------+------------+--------+--------------+--------------+
| i1, j0 | i1, j1 | i1, j2 | .... | i1, jP-2 | i1, jP-1 |
+------------+------------+------------+--------+--------------+--------------+
| ........ | ........ | ........ | .... | .......... | .......... |
......
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.MicroDataGroup``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_microdata_example_thumb.png
.. figure:: /auto_examples/images/thumb/sphx_glr_plot_microdata_example_thumb.png
:ref:`sphx_glr_auto_examples_microdata_example.py`
:ref:`sphx_glr_auto_examples_plot_microdata_example.py`
.. raw:: html
......@@ -19,7 +19,7 @@ Examples using ``pycroscopy.MicroDataGroup``
.. only:: not html
* :ref:`sphx_glr_auto_examples_microdata_example.py`
* :ref:`sphx_glr_auto_examples_plot_microdata_example.py`
.. raw:: html
......@@ -27,9 +27,9 @@ Examples using ``pycroscopy.MicroDataGroup``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_02_writing_to_h5_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
......@@ -37,7 +37,7 @@ Examples using ``pycroscopy.MicroDataGroup``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
......@@ -45,9 +45,9 @@ Examples using ``pycroscopy.MicroDataGroup``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_05_data_processing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
......@@ -55,4 +55,40 @@ Examples using ``pycroscopy.MicroDataGroup``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath** 8/8/2017">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.MicroDataset``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_microdata_example_thumb.png
.. figure:: /auto_examples/images/thumb/sphx_glr_plot_microdata_example_thumb.png
:ref:`sphx_glr_auto_examples_microdata_example.py`
:ref:`sphx_glr_auto_examples_plot_microdata_example.py`
.. raw:: html
......@@ -19,7 +19,7 @@ Examples using ``pycroscopy.MicroDataset``
.. only:: not html
* :ref:`sphx_glr_auto_examples_microdata_example.py`
* :ref:`sphx_glr_auto_examples_plot_microdata_example.py`
.. raw:: html
......@@ -27,9 +27,9 @@ Examples using ``pycroscopy.MicroDataset``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_02_writing_to_h5_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
......@@ -37,7 +37,7 @@ Examples using ``pycroscopy.MicroDataset``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
......@@ -45,9 +45,9 @@ Examples using ``pycroscopy.MicroDataset``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_05_data_processing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
......@@ -55,4 +55,40 @@ Examples using ``pycroscopy.MicroDataset``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath** 8/8/2017">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.NumpyTranslator``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_01_translator_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_01_translator_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_01_translator.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_01_translator.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.NumpyTranslator``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_01_translator.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_01_translator.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath** 8/8/2017">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_01_translator_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_01_translator.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_01_translator.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.Process``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_05_data_processing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.Process``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.PycroDataset``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_03_multidimensional_data_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_03_multidimensional_data_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_03_multidimensional_data.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_03_multidimensional_data.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.PycroDataset``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_03_multidimensional_data.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_03_multidimensional_data.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath** 8/8/2017">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_03_multidimensional_data_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_03_multidimensional_data.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_03_multidimensional_data.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.analysis.be_sho.SHOestimateGuess``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_04_parallel_computing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_04_parallel_computing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_04_parallel_computing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_04_parallel_computing.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.analysis.be_sho.SHOestimateGuess``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_04_parallel_computing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_04_parallel_computing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath, Chris R. Smith**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_04_parallel_computing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_04_parallel_computing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_04_parallel_computing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.analysis.be_sho.SHOfunc``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_04_parallel_computing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_04_parallel_computing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_04_parallel_computing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_04_parallel_computing.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.analysis.be_sho.SHOfunc``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_04_parallel_computing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_04_parallel_computing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath, Chris R. Smith**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_04_parallel_computing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_04_parallel_computing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_04_parallel_computing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.be_sho.SHOestimateGuess``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_05_data_processing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.be_sho.SHOestimateGuess``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.be_sho.SHOfunc``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_05_data_processing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.be_sho.SHOfunc``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.hdf_utils.buildReducedSpec``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_05_data_processing_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.hdf_utils.buildReducedSpec``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_05_data_processing.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath**">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_05_data_processing_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_05_data_processing.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.hdf_utils.checkAndLinkAncillary``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_02_writing_to_h5_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.hdf_utils.checkAndLinkAncillary``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath** 8/8/2017">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
Examples using ``pycroscopy.hdf_utils.checkIfMain``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="11/11/2017">
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_plot_tutorial_01_interacting_w_h5_files_thumb.png
:ref:`sphx_glr_auto_examples_plot_tutorial_01_interacting_w_h5_files.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_examples_plot_tutorial_01_interacting_w_h5_files.py`
Examples using ``pycroscopy.hdf_utils.check_for_old``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="11/11/2017">
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_plot_tutorial_01_interacting_w_h5_files_thumb.png
:ref:`sphx_glr_auto_examples_plot_tutorial_01_interacting_w_h5_files.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_examples_plot_tutorial_01_interacting_w_h5_files.py`
......@@ -9,9 +9,9 @@ Examples using ``pycroscopy.hdf_utils.copy_main_attributes``
.. only:: html
.. figure:: /auto_examples/images/thumb/sphx_glr_tutorial_02_writing_to_h5_thumb.png
.. figure:: /auto_examples/tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
:ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
......@@ -19,4 +19,22 @@ Examples using ``pycroscopy.hdf_utils.copy_main_attributes``
.. only:: not html
* :ref:`sphx_glr_auto_examples_tutorial_02_writing_to_h5.py`
* :ref:`sphx_glr_auto_examples_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
<div class="sphx-glr-thumbcontainer" tooltip="**Suhas Somnath** 8/8/2017">
.. only:: html
.. figure:: /auto_tutorials/images/thumb/sphx_glr_plot_tutorial_02_writing_to_h5_thumb.png
:ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
.. raw:: html
</div>
.. only:: not html
* :ref:`sphx_glr_auto_tutorials_plot_tutorial_02_writing_to_h5.py`
Examples using ``pycroscopy.hdf_utils.findDataset``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^