Skip to content

Commit 61be21f

Browse files
philipstarkeychrisjbillingtonrpanderson
committed
Squashed commit of the following:
commit 6868c8e Author: Phil Starkey <philipstarkey@users.noreply.github.com> 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 <philipstarkey@users.noreply.github.com> 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 <chrisjbillington@gmail.com> 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 <5637107+rpanderson@users.noreply.github.com> 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 <philipstarkey@users.noreply.github.com> Date: Tue Jun 23 17:34:57 2020 +1000 Incorrect behaviour of default output directory on first run Fixes #71 commit b007f3e Author: philipstarkey <philipstarkey@users.noreply.github.com> 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 <5637107+rpanderson@users.noreply.github.com> Date: Mon Jun 22 18:08:55 2020 +1000 Merge pull request #90 from philipstarkey/master Doc updates commit cda516d Author: philipstarkey <philipstarkey@users.noreply.github.com> 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 <philipstarkey@users.noreply.github.com> 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 <philipstarkey@users.noreply.github.com> Date: Fri Jun 19 17:07:02 2020 +1000 Fixed incorrect component used for version commit 859a44d Author: philipstarkey <philipstarkey@users.noreply.github.com> Date: Fri Jun 19 16:00:13 2020 +1000 Addressing latest review comments commit 6c763e7 Author: philipstarkey <philipstarkey@users.noreply.github.com> Date: Fri Jun 19 11:18:36 2020 +1000 Added missing todolist directive on index page commit 6466ff0 Author: philipstarkey <philipstarkey@users.noreply.github.com> Date: Fri Jun 19 11:10:29 2020 +1000 Updated docs to use jinja template for component doc links commit 841840a Author: philipstarkey <philipstarkey@users.noreply.github.com> Date: Thu Jun 18 17:30:33 2020 +1000 Initial commit of sphinx docs commit fbbdfa0 Author: Russell Anderson <5637107+rpanderson@users.noreply.github.com> 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 <5637107+rpanderson@users.noreply.github.com> 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 <5637107+rpanderson@users.noreply.github.com> 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 <chrisjbillington@gmail.com> Co-authored-by: Russell Anderson <5637107+rpanderson@users.noreply.github.com>
1 parent d4949f1 commit 61be21f

19 files changed

+1818
-16
lines changed

‎.gitignore‎

Lines changed: 161 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,161 @@
1-
*.pyc
2-
dist
3-
*.egg-info
4-
.eggs
5-
conda_build
6-
conda_packages
1+
# This gitignore file consists of 2 parts:
2+
# * The standard Python .gitignore rules from GitHub
3+
# * custom ignore rules for the labscript suite.
4+
#
5+
# These should be kept separate so that the generic rules can be updated with a
6+
# copy/paste without having to worry about whether we are removing custom rules
7+
8+
# Byte-compiled / optimized / DLL files
9+
__pycache__/
10+
*.py[cod]
11+
*$py.class
12+
13+
# C extensions
14+
*.so
15+
16+
# Distribution / packaging
17+
.Python
18+
build/
19+
develop-eggs/
20+
dist/
21+
downloads/
22+
eggs/
23+
.eggs/
24+
lib/
25+
lib64/
26+
parts/
27+
sdist/
28+
var/
29+
wheels/
30+
share/python-wheels/
31+
*.egg-info/
32+
.installed.cfg
33+
*.egg
34+
MANIFEST
35+
36+
# PyInstaller
37+
# Usually these files are written by a python script from a template
38+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
39+
*.manifest
40+
*.spec
41+
42+
# Installer logs
43+
pip-log.txt
44+
pip-delete-this-directory.txt
45+
46+
# Unit test / coverage reports
47+
htmlcov/
48+
.tox/
49+
.nox/
50+
.coverage
51+
.coverage.*
52+
.cache
53+
nosetests.xml
54+
coverage.xml
55+
*.cover
56+
*.py,cover
57+
.hypothesis/
58+
.pytest_cache/
59+
cover/
60+
61+
# Translations
62+
*.mo
63+
*.pot
64+
65+
# Django stuff:
66+
*.log
67+
local_settings.py
68+
db.sqlite3
69+
db.sqlite3-journal
70+
71+
# Flask stuff:
72+
instance/
73+
.webassets-cache
74+
75+
# Scrapy stuff:
76+
.scrapy
77+
78+
# Sphinx documentation
79+
docs/_build/
80+
81+
# PyBuilder
82+
.pybuilder/
83+
target/
84+
85+
# Jupyter Notebook
86+
.ipynb_checkpoints
87+
88+
# IPython
89+
profile_default/
90+
ipython_config.py
91+
92+
# pyenv
93+
# For a library or package, you might want to ignore these files since the code is
94+
# intended to run in multiple environments; otherwise, check them in:
95+
.python-version
96+
97+
# pipenv
98+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
99+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
100+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
101+
# install all needed dependencies.
102+
#Pipfile.lock
103+
104+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
105+
__pypackages__/
106+
107+
# Celery stuff
108+
celerybeat-schedule
109+
celerybeat.pid
110+
111+
# SageMath parsed files
112+
*.sage.py
113+
114+
# Environments
115+
.env
116+
.venv
117+
env/
118+
venv/
119+
ENV/
120+
env.bak/
121+
venv.bak/
122+
123+
# Spyder project settings
124+
.spyderproject
125+
.spyproject
126+
127+
# Rope project settings
128+
.ropeproject
129+
130+
# mkdocs documentation
131+
/site
132+
133+
# mypy
134+
.mypy_cache/
135+
.dmypy.json
136+
dmypy.json
137+
138+
# Pyre type checker
139+
.pyre/
140+
141+
# pytype static type analyzer
142+
.pytype/
143+
144+
# Cython debug symbols
145+
cython_debug/
146+
147+
#
148+
# Custom labscript suite .gitignore rules start below
149+
#
150+
151+
# Editors
152+
.vscode/
153+
154+
# conda build results
155+
conda_build/
156+
conda_packages/
157+
158+
# Sphinx documentation
159+
docs/html/
160+
docs/source/_build/
161+
docs/source/components.rst

‎README.md‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
1-
# runmananger
1+
<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/runmanager_32nx32n.svg" height="64" alt="the labscript suite – runmanager" align="right">
22

3-
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.
3+
# the _labscript suite_ » runmanager
44

5-
([view on Github](https://github.com/labscript-suite/runmananger))
5+
### Graphical and remote interface to parameterized experiments
66

7+
[![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)
8+
[![License](https://img.shields.io/pypi/l/runmanager.svg)](https://github.com/labscript-suite/runmanager/raw/master/LICENSE.txt)
9+
[![Python Version](https://img.shields.io/pypi/pyversions/runmanager.svg)](https://python.org)
10+
[![PyPI](https://img.shields.io/pypi/v/runmanager.svg)](https://pypi.org/project/runmanager)
11+
[![Conda Version](https://img.shields.io/conda/v/labscript-suite/runmanager)](https://anaconda.org/labscript-suite/runmanager)
12+
[![Google Group](https://img.shields.io/badge/Google%20Group-labscriptsuite-blue.svg)](https://groups.google.com/forum/#!forum/labscriptsuite)
13+
<!--[![DOI](http://img.shields.io/badge/DOI-10.1063%2F1.4817213-0F79D0.svg)](https://doi.org/10.1063/1.4817213)-->
14+
15+
16+
**runmanager** is an intuitive graphical interface for controlling [*labscript suite*](https://github.com/labscript-suite/labscript-suite) experiments.
17+
18+
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.
19+
20+
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.
21+
22+
23+
## Installation
24+
25+
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‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/_static/custom.css‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/* Add space between collapsible details HTML tags */
2+
details {
3+
margin-bottom: 1em;
4+
}
5+
6+
/* Darker pygment highlighing of console input/output */
7+
.highlight .go {
8+
color: #404040;
9+
}
10+
11+
/* White captions in sidebar */
12+
.wy-nav-side p.caption {
13+
color: #f5f5f5;
14+
}
15+
16+
/* labscript blue, alpha = 83% */
17+
.wy-side-nav-search {
18+
background: #2946bbd3;
19+
}
20+
21+
.wy-nav-top {
22+
background: #2946bbd3;
23+
}
24+
25+
/* labscript green, alpha = 75% */
26+
.rst-content .note .admonition-title {
27+
background: #00804fbf;
28+
}
29+
30+
/* labscript green, alpha = 25% */
31+
.rst-content .note {
32+
background: #00804f3f;
33+
}
34+
35+
/* labscript red, alpha = 75% */
36+
.rst-content .warning .admonition-title {
37+
background: #bc294cbf
38+
}
39+
40+
/* labscript red, alpha = 25% */
41+
.rst-content .warning {
42+
background: #bc294c3b;
43+
}
44+
45+
/* Elevation
46+
*
47+
* Style box-shadows using Material Design's idea of elevation. These particular numbers are taken from here:
48+
*
49+
* https://github.com/material-components/material-components-web
50+
* https://material-components-web.appspot.com/elevation.html
51+
*/
52+
53+
.rst-content img.screenshot {
54+
border: none;
55+
/* MD Elevation 8 */
56+
box-shadow: 0px 5px 5px -3px rgba(0, 0, 0, 0.2),
57+
0px 8px 10px 1px rgba(0, 0, 0, 0.14), 0px 3px 14px 2px rgba(0, 0, 0, 0.12);
58+
margin-bottom: 24px;
59+
}
60+
61+
img.labscript-suite-icon {
62+
min-width: 32px;
63+
}

‎docs/source/_templates/components.rst‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
{% if current_project != 'the labscript suite' %}
2+
.. toctree::
3+
:maxdepth: 2
4+
:hidden:
5+
6+
the labscript suite <{{intersphinx_mapping['labscript-suite'][0]}}>
7+
8+
{% endif %}
9+
*labscript suite* components
10+
============================
11+
12+
The *labscript suite* is modular by design, and is comprised of:
13+
14+
.. list-table:: Python libraries
15+
:widths: 10 90
16+
:header-rows: 0
17+
18+
{% for prog, item in programs.items() if item.type == 'lib' %}
19+
* - .. image:: {{img_path}}/{{item.icon}}
20+
:target: {{intersphinx_mapping['%s' | format(prog)][0]}}
21+
:class: labscript-suite-icon
22+
- |{{prog}}|_ --- {{item.desc}}
23+
{% endfor %}
24+
25+
.. list-table:: Graphical applications
26+
:widths: 10 90
27+
:header-rows: 0
28+
29+
{% for prog, item in programs.items() if item.type == 'gui' %}
30+
* - .. image:: {{img_path}}/{{item.icon}}
31+
:target: {{intersphinx_mapping['%s' | format(prog)][0]}}
32+
:class: labscript-suite-icon
33+
- |{{prog}}|_ --- {{item.desc}}
34+
{% endfor %}
35+
36+
.. toctree::
37+
:maxdepth: 2
38+
:hidden:
39+
40+
{% for prog in programs|sort if prog != current_project %}
41+
{{prog}} <{{intersphinx_mapping['%s' | format(prog)][0]}}>
42+
{% endfor %}
43+
44+
{% for prog in programs %}
45+
.. |{{prog}}| replace:: **{{prog}}**
46+
.. _{{prog}}: {{intersphinx_mapping['%s' | format(prog)][0]}}
47+
{% endfor %}

‎docs/source/api/index.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
=============
2+
API Reference
3+
=============
4+
5+
.. automodule:: runmanager
6+
:members:
7+
:show-inheritance:
8+
9+
10+

0 commit comments

Comments
 (0)