Commit 16787133 authored by Thomas Vincent's avatar Thomas Vincent

update starting xsocs, add doc of command line options

parent 76f5bc96
.. role:: bash(code)
:language: bash
Starting X-SOCS
===============
Once installed, you can run XSOCS from the console with either::
Once installed, you can run X-SOCS from the command line with:
xsocs
.. code-block:: bash
Or::
python -m xsocs
Or from the python interpreter:
>>> from xsocs.gui import xsocs_main
>>> xsocs_main()
xsocs
or, alternatively with ``python -m xsocs``.
This will open X-SOCS main window, with no project loaded.
+------------------------------+
| Main window |
+==============================+
| .. image:: img/main_view.png |
+------------------------------+
.. figure:: img/main_view.png
:align: center
Main Window
You can then load an :ref:`existing project <load_project>`
or :ref:`create a new one <create_project>`.
Command line options
--------------------
Some options are available from the command line:
.. program-output:: python -m xsocs help
Graphical User interface
++++++++++++++++++++++++
.. program-output:: python -m xsocs help gui
Datasets 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