Commit d852114d authored by Thomas Vincent's avatar Thomas Vincent

update project loading doc

parent 16787133
......@@ -77,6 +77,8 @@ extensions = [
'sphinxcontrib.programoutput',
]
numfig = True
autodoc_member_order = 'bysource'
# Add any paths that contain templates here, relative to this directory.
......
......@@ -2,66 +2,59 @@
Loading a project
=================
The first thing to do once you have started X-SOCS is to create a project. It will contain
all the information (input and processed data) about a single sample.
Once X-SOCS is started, you can either create a `New project`_ or open an `Existing project`_.
From there you can either :ref:`load an existing project <load_project>`
or :ref:`create a new project <create_project>`.
A project contains the information about a single K-map acquisition (scans and calibration) and stores data reduction results (conversion to QSpace and fit).
.. _load_project:
.. _create_project:
New project
-----------
Existing project
----------------
.. |create_icon| image:: ../../../xsocs/resources/gui/icons/create_project.png
.. |open_icon| image:: img/open_icon.png
To start the project creation wizard, click on the |create_icon| button in the toolbar or select the **Create project** item in the **File** menu.
.. |open_dialog| image:: img/open_dialog.png
The first page will ask you for the folder path into which the new project will be created.
To load an existing project simply click on the `open project`
button |open_icon| in the toolbar or select the "`File/Open project`" menu
item. A dialog will open, which allows you to browse to the xsocs.proj file
you want to open and review its content.
.. warning::
There can be only one project per folder!
A confirmation dialog will pop up if a project file is already present in the chosen directory.
+------------------------------+
| Open project dialog |
+==============================+
| |open_dialog| |
+------------------------------+
The next page gives you the choice between:
From there you can either choose a different file, or confirm your
choice and load the selected project. The :ref:`project tree <create_project>`
will then be populated with the project information.
#. **Load X-Socs data (HDF5)** to import K-map data already in HDF5 format.
.. _create_project:
To load data that has already been merged, select the `master` file of the merged data (the file that contains links to all entries).
New project
-----------
#. **Import SPEC data** to import K-map data from SPEC and EDF files.
.. |create_icon| image:: ../../../xsocs/resources/gui/icons/create_project.png
X-SOCS will merge the SPEC file and the EDF images into HDF5 files.
To start the project creation wizard simmply click on the `create project` button
|create_icon| in the toolbar or select the "`File/Create project`" menu item.
The first page will ask for the folder path into which the new project will be
created.
See :ref:`merging K-map SPEC and EDF data <merge_kmap>` for details.
.. warning::
Please keep in mind that there can be only one project per folder! A
confirmation dialog will pop up if a project file is already present in the
chosen directory.
Once data has been imported, X-SOCS sums the intensity of all images.
This can take quite some time depending on the size of the acquired data.
.. _figure_open_dialog:
.. figure:: img/open_dialog.png
:align: center
:width: 50%
Open project summary page
Finally, the project summary page (:numref:`figure_open_dialog`) provides the description of the scans from which the project has been created.
Click on **Finish** to display the newly created project in the :ref:`project tree window <project_tree>`.
The next page gives you a choice between importing `SPEC` and `EDF` data
(and merge them into HDF5 files) or importing already merged HDF5 files.
#. Importing SPEC + EDF KMAP data
X-SOCS will merge the SPEC file and the EDF images into HDF5 files.
Please see :ref:`the page about merging KMAP SPEC and EDF data <merge_kmap>`.
.. _load_project:
Existing project
----------------
.. |open_icon| image:: img/open_icon.png
#. Importing HDF5 merged data
To load the data that has already been merged select the `master` file of
the merged data (the file that contains links to all entries).
To load an existing project click on the |open_icon| button in the toolbar or select the **Open project** item in the **File** menu.
This opens a file dialog which allows you to browse to and select a ``xsocs.prj`` file.
When this is done, X-SOCS will start summing all images. This can take a while
depending on the size of the acquired data.
Once the project file is selected, the project summary page (:numref:`figure_open_dialog`) provides the description of the scans contained in the project.
Click on `Finish` to display the newly created project in the
:ref:`main window <project_tree>`.
From there you can either cancel, or click on **Finish** to load the selected project in the :ref:`project tree window <project_tree>`.
......@@ -19,8 +19,10 @@ This will open X-SOCS main window, with no project loaded.
Main Window
You can then load an :ref:`existing project <load_project>`
or :ref:`create a new one <create_project>`.
You can then either:
- :ref:`Create a new project <create_project>`, or
- :ref:`Load an existing one <load_project>`.
Command line options
--------------------
......@@ -34,7 +36,7 @@ Graphical User interface
.. program-output:: python -m xsocs help gui
Datasets concatenation
++++++++++++++++++++++
Dataset concatenation
+++++++++++++++++++++
.. program-output:: python -m xsocs help concat
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment