Squashed commit of the following:

commit 6868c8e
Author: Phil Starkey <[email protected]>
Date:   Thu Jun 25 18:43:47 2020 +1000

    Update dependencies in setup.cfg

    Bumped labscript and labscript_utils versions to `>=3.0.0`

commit be2dc40
Merge: 6a7d105 80f272e
Author: Phil Starkey <[email protected]>
Date:   Thu Jun 25 12:17:20 2020 +1000

    Merge pull request #95 from chrisjbillington:use-runviewer-launcher

    Fix issue #92

commit 80f272e
Author: chrisjbillington <[email protected]>
Date:   Wed Jun 24 20:45:17 2020 -0400

    Fix issue #92

    Launch runviewer using the runviewer-gui launcher, for consistency with
    how it would be launched by a human, and to ensure it has a hidden
    console window of its own instead of no console window (the cause of
    issue #92).

commit 6a7d105
Merge: b007f3e df99aee
Author: Russell Anderson <[email protected]>
Date:   Wed Jun 24 08:18:13 2020 +1000

    Merge pull request #91 from philipstarkey/philipstarkey/issue71

    Incorrect behaviour of default output directory on first run

commit df99aee
Author: philipstarkey <[email protected]>
Date:   Tue Jun 23 17:34:57 2020 +1000

    Incorrect behaviour of default output directory on first run
    Fixes #71

commit b007f3e
Author: philipstarkey <[email protected]>
Date:   Tue Jun 23 18:31:22 2020 +1000

    Fix #93: Can't restart subprocess
    Fixes #93

commit 3cf2808
Merge: 2613d48 cda516d
Author: Russell Anderson <[email protected]>
Date:   Mon Jun 22 18:08:55 2020 +1000

    Merge pull request #90 from philipstarkey/master

    Doc updates

commit cda516d
Author: philipstarkey <[email protected]>
Date:   Sat Jun 20 18:12:50 2020 +1000

    Doc updates

    Renamed API reference URL to match labscript utils and updated config to fix bugs identified in labscript-suite/labscript-utils#57

commit 2613d48
Merge: fbbdfa0 a27a239
Author: Phil Starkey <[email protected]>
Date:   Fri Jun 19 18:59:59 2020 +1000

    Merge pull request #89 from philipstarkey/master

    Initial commit of sphinx docs

commit a27a239
Author: philipstarkey <[email protected]>
Date:   Fri Jun 19 17:07:02 2020 +1000

    Fixed incorrect component used for version

commit 859a44d
Author: philipstarkey <[email protected]>
Date:   Fri Jun 19 16:00:13 2020 +1000

    Addressing latest review comments

commit 6c763e7
Author: philipstarkey <[email protected]>
Date:   Fri Jun 19 11:18:36 2020 +1000

    Added missing todolist directive on index page

commit 6466ff0
Author: philipstarkey <[email protected]>
Date:   Fri Jun 19 11:10:29 2020 +1000

    Updated docs to use jinja template for component doc links

commit 841840a
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 17:30:33 2020 +1000

    Initial commit of sphinx docs

commit fbbdfa0
Author: Russell Anderson <[email protected]>
Date:   Wed Jun 17 11:40:02 2020 +1000

    Populated README.md with styling, iconogrpahy, prose, and badges

commit ce96779
Merge: 7562830 a1e2462
Author: Russell Anderson <[email protected]>
Date:   Tue Jun 16 12:06:56 2020 +1000

    Merge pull request #88 from rpanderson/master

    experiment_name changed to apparatus_name

commit a1e2462
Author: Russell Anderson <[email protected]>
Date:   Wed Jun 10 22:52:20 2020 +1000

    experiment_name changed to apparatus_name

    Per labscript-suite/labscript-utils#53

Co-authored-by: chrisjbillington <[email protected]>
Co-authored-by: Russell Anderson <[email protected]>

.gitignore

@@ -1,6 +1,161 @@
-*.pyc
-dist
-*.egg-info
-.eggs
-conda_build
-conda_packages
+# This gitignore file consists of 2 parts:
+#   * The standard Python .gitignore rules from GitHub
+#   * custom ignore rules for the labscript suite.
+#
+# These should be kept separate so that the generic rules can be updated with a
+# copy/paste without having to worry about whether we are removing custom rules
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+#
+# Custom labscript suite .gitignore rules start below
+#
+
+# Editors
+.vscode/
+
+# conda build results
+conda_build/
+conda_packages/
+
+# Sphinx documentation
+docs/html/
+docs/source/_build/
+docs/source/components.rst

README.md

@@ -1,6 +1,25 @@
-# runmananger
+<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/runmanager_32nx32n.svg" height="64" alt="the labscript suite – runmanager" align="right">
 
-runmanager is a graphical user interface (GUI) used to aid the compilation of labscript experiment scripts into hardware instructions to be executed on the hardware. Experiment parameters can be adjusted in the GUI, and lists of parameters can be used to create sequences of experiments, and scan over complex parameter spaces.
+# the _labscript suite_ » runmanager
 
-([view on Github](https://github.com/labscript-suite/runmananger))
+### Graphical and remote interface to parameterized experiments
 
+[![Actions Status](https://github.com/labscript-suite/runmanager/workflows/Build%20and%20Release/badge.svg?branch=maintenance%2F3.0.x)](https://github.com/labscript-suite/runmanager/actions)
+[![License](https://img.shields.io/pypi/l/runmanager.svg)](https://github.com/labscript-suite/runmanager/raw/master/LICENSE.txt)
+[![Python Version](https://img.shields.io/pypi/pyversions/runmanager.svg)](https://python.org)
+[![PyPI](https://img.shields.io/pypi/v/runmanager.svg)](https://pypi.org/project/runmanager)
+[![Conda Version](https://img.shields.io/conda/v/labscript-suite/runmanager)](https://anaconda.org/labscript-suite/runmanager)
+[![Google Group](https://img.shields.io/badge/Google%20Group-labscriptsuite-blue.svg)](https://groups.google.com/forum/#!forum/labscriptsuite)
+<!--[![DOI](http://img.shields.io/badge/DOI-10.1063%2F1.4817213-0F79D0.svg)](https://doi.org/10.1063/1.4817213)-->
+
+
+**runmanager** is an intuitive graphical interface for controlling [*labscript suite*](https://github.com/labscript-suite/labscript-suite) experiments.
+
+Experiment parameters are defined and modified in runmanager and referenced in the labscript experiment logic (Python scripts). runmanager provides a potent framework for parameter space exploration; parameters can be raw Python expressions, with multiple iterable parameters scanned over via an outer product and/or in unison.
+
+runmanager can be run on any host with network access to the hardware supervisor [**blacs**](https://github.com/labscript-suite/blacs), and includes a remote programming interface for automation.
+
+
+## Installation
+
+runmanager is distributed as a Python package on [PyPI](https://pypi.org/user/labscript-suite) and [Anaconda Cloud](https://anaconda.org/labscript-suite), and should be installed with other components of the _labscript suite_. Please see the [installation guide](https://docs.labscriptsuite.org/en/latest/installation) for details.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/custom.css

@@ -0,0 +1,63 @@
+/* Add space between collapsible details HTML tags */
+details {
+    margin-bottom: 1em;
+}
+
+/* Darker pygment highlighing of console input/output */
+.highlight .go {
+    color: #404040;
+}
+
+/* White captions in sidebar */
+.wy-nav-side p.caption {
+    color: #f5f5f5;
+}
+
+/* labscript blue, alpha = 83% */
+.wy-side-nav-search {
+    background: #2946bbd3;
+}
+
+.wy-nav-top {
+    background: #2946bbd3;
+}
+
+/* labscript green, alpha = 75% */
+.rst-content .note .admonition-title {
+    background: #00804fbf;
+}
+
+/* labscript green, alpha = 25% */
+.rst-content .note {
+    background: #00804f3f;
+}
+
+/* labscript red, alpha = 75% */
+.rst-content .warning .admonition-title {
+    background: #bc294cbf
+}
+
+/* labscript red, alpha = 25% */
+.rst-content .warning {
+    background: #bc294c3b;
+}
+
+/* Elevation
+*
+* Style box-shadows using Material Design's idea of elevation. These particular numbers are taken from here:
+*
+* https://github.com/material-components/material-components-web
+* https://material-components-web.appspot.com/elevation.html
+*/
+
+.rst-content img.screenshot {
+    border: none;
+    /* MD Elevation 8 */
+    box-shadow: 0px 5px 5px -3px rgba(0, 0, 0, 0.2),
+        0px 8px 10px 1px rgba(0, 0, 0, 0.14), 0px 3px 14px 2px rgba(0, 0, 0, 0.12);
+    margin-bottom: 24px;
+}
+
+img.labscript-suite-icon {
+    min-width: 32px;
+}

docs/source/_templates/components.rst

@@ -0,0 +1,47 @@
+{% if current_project != 'the labscript suite' %}
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    the labscript suite <{{intersphinx_mapping['labscript-suite'][0]}}>
+
+{% endif %}
+*labscript suite* components
+============================
+
+The *labscript suite* is modular by design, and is comprised of:
+
+.. list-table:: Python libraries
+    :widths: 10 90
+    :header-rows: 0
+
+    {% for prog, item in programs.items() if item.type == 'lib' %}
+    * - .. image:: {{img_path}}/{{item.icon}}
+             :target: {{intersphinx_mapping['%s' | format(prog)][0]}}
+             :class: labscript-suite-icon
+      - |{{prog}}|_ --- {{item.desc}}
+    {% endfor %}
+
+.. list-table:: Graphical applications
+    :widths: 10 90
+    :header-rows: 0
+
+    {% for prog, item in programs.items() if item.type == 'gui' %}
+    * - .. image:: {{img_path}}/{{item.icon}}
+             :target: {{intersphinx_mapping['%s' | format(prog)][0]}}
+             :class: labscript-suite-icon
+      - |{{prog}}|_ --- {{item.desc}}
+    {% endfor %}
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    {% for prog in programs|sort if prog != current_project %}
+    {{prog}} <{{intersphinx_mapping['%s' | format(prog)][0]}}>
+    {% endfor %}
+
+{% for prog in programs %}
+.. |{{prog}}| replace:: **{{prog}}**
+.. _{{prog}}: {{intersphinx_mapping['%s' | format(prog)][0]}}
+{% endfor %}

docs/source/api/index.rst

@@ -0,0 +1,10 @@
+=============
+API Reference
+=============
+
+.. automodule:: runmanager
+    :members:
+    :show-inheritance:
+
+
+