Commit caaf6fd5 authored by payno's avatar payno

[doc] add some documentation

parent bdb24bd1
============
Applications
============
.. toctree::
:maxdepth: 1
process
process
-------
You can use the workflow definition from a .ows (orange) file with it configuration to process different spectrum.
For this you should execute the `process` application
.. code-block:: bash
xas process pymca_workflow.ows -i [input_spectrum_file] -o [output_file]
......@@ -34,6 +34,7 @@ sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'ext'))
# ones.
extensions = [
'sphinx.ext.autodoc',
'nbsphinx',
]
# Add any paths that contain templates here, relative to this directory.
......
......@@ -9,32 +9,20 @@ TODO
:hidden:
tutorials/index.rst
install.rst
app/index.rst
:doc:`install`
Installation
:doc:`app/index`
Applications
:doc:`tutorials/index`
tutorials for using the xas library
-----------------------------
xas on esrf official debian 8
-----------------------------
A xas module for debian 8 is provided.
This mean that if you have an esrf official debian 8 distribution you can load the module:
.. code-block:: bash
module load xas_orange
and execute xas.
.. code-block:: bash
xas_orange [myworkflow.ows]
--------------
Orange Widgets
......
installation
::::::::::::
xas is library made to link several xas libraries together and define treatment workflows.
This is the recommended way to install xas.
Step 1 - Create a virtual env
'''''''''''''''''''''''''''''
It is recommended to create a python virtual environment to run the workflow tool.
Virtual environment might avoid some conflict between python packages. But you can also install it on your 'current' python environment and move to step 1.
.. code-block:: bash
virtualenv --python=python3 --system-site-packages myvirtualenv
Then activate the virtual environment
.. code-block:: bash
source myvirtualenv/bin/activate
.. note:: To quit the virtual environment
.. code-block:: bash
deactivate
Step 2 installation
'''''''''''''''''''
You can install from the code source (https://gitlab.esrf.fr/workflow/xas)
.. code-block:: bash
pip install .[full]
Or install it from pypi:
.. code-block:: bash
pip install xas[full]
Launching Orange
::::::::::::::::
xas is offering an orange add-on for having a convenient and user friendly way to define a treatment workflow.
To launch orange and access the xas add-on you can simply launch Orange2 with the command:
.. code-block:: bash
orange-canvas
.. note:: if your installed a virtual environment do not forget to active it :
.. code-block:: bash
source myvirtualenv/bin/activate
Documentation
:::::::::::::
.. code-block:: bash
cd doc
make html
The documentation is build in doc/build/html and the entry point is index.html
.. code-block:: bash
firefox build/html/index.html
.. note:: the build of the documentation need sphinx to be installed. This is not an hard dependency. So you might need to install it.
You also should generate documentation to be accessible from Orange GUI (pressing the F1 key).
.. code-block:: bash
cd doc
make htmlhelp
To get more information about help from Orange see :
:doc:`other/help`
accessing documentation from the interface
Warning
:::::::
the xas GUI is using silx from the silx.gui.qt module which try to use PyQt5, then PySide2, then PyQt4
Order is different for AnyQt, used by Orange3. So some incoherence might append (will bring errors) in the Signal/SLOT connection
during widget instantiation.
You should be careful about it if more than one Qt binding is available (one quick and durty fix is to change the AnyQt/__init__.py file - 'availableapi' function for example)
=========
Tutorials
=========
pymca xas
---------
.. toctree::
:maxdepth: 1
xas_process
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