Skip to content
Snippets Groups Projects
Commit 6d0231ec authored by Martyn Gigg's avatar Martyn Gigg
Browse files

Add workbench developer document

parent 2b4cafcb
No related branches found
No related tags found
No related merge requests found
.. _Workbench:
=====================
Workbench Development
=====================
.. contents::
:local:
Overview
########
The workbench is the new PyQt-based GUI that will be the primary interface for
interacting with the mantid framework. The plotting is provided by
`matplotlib <https://matplotlib.org/>`_. It will eventually replace MantidPlot.
Building
########
The following build instructions assume you have follwed the instructions on the :ref:`GettingStarted` pages and can build mantid and MantidPlot. To enable the
build of the workbench simply set the cmake flag ``ENABLE_WORKBENCH=ON`` and
build as normal. A ``workbench`` startup script (Linux/macOS) or executable (Windows) will appear in the ``bin`` folder. For Windows the executable will appear in the configuration subdirectory of ``bin``.
Packaging
#########
Packaging is currently only supported on Linux platforms and must be enabled
using the cmake flag ``PACKAGE_WORKBENCH=ON``.
......@@ -208,5 +208,6 @@ Component Overviews
MultiThreadingInAlgorithms
PythonVSCppAlgorithms
RemoteJobSubmissionAPI
Workbench
WritingAnAlgorithm
WritingCustomConvertToMDTransformation
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment