Skip to content

Commit 8f441c5

Browse files
philipstarkeyrpanderson
philipstarkey
and
rpanderson
committed
Squashed commit of the following:
commit fc4e42a Author: Phil Starkey <philipstarkey@users.noreply.github.com> Date: Thu Jun 25 19:53:12 2020 +1000 Update dependencies in setup.cfg Bumped labscript_devices and labscript_utils versions to `>=3.0.0` commit 5d48b01 Merge: d7dbb60 760b82c Author: Russell Anderson <5637107+rpanderson@users.noreply.github.com> Date: Mon Jun 22 18:07:48 2020 +1000 Merge pull request #43 from philipstarkey/master fix docs conf bugs identified in labscript-suite/labscript-utils#57 commit 760b82c Author: philipstarkey <philipstarkey@users.noreply.github.com> Date: Sat Jun 20 18:29:58 2020 +1000 fix docs conf bugs identified in labscript-suite/labscript-utils#57 commit d7dbb60 Merge: 8eac42a fd63ef4 Author: Phil Starkey <philipstarkey@users.noreply.github.com> Date: Fri Jun 19 19:00:21 2020 +1000 Merge pull request #42 from philipstarkey/master Empty sphinx project following our template commit fd63ef4 Author: philipstarkey <philipstarkey@users.noreply.github.com> Date: Fri Jun 19 17:08:29 2020 +1000 Empty sphinx project following our template commit 8eac42a Author: Russell Anderson <5637107+rpanderson@users.noreply.github.com> Date: Wed Jun 17 10:31:32 2020 +1000 Contextualise installation instructions in README.md commit a54f961 Author: Russell Anderson <5637107+rpanderson@users.noreply.github.com> Date: Tue Jun 16 21:07:05 2020 +1000 Populated README.md with styling, iconogrpahy, prose, and badges Co-authored-by: Russell Anderson <5637107+rpanderson@users.noreply.github.com>
1 parent 7d94422 commit 8f441c5

17 files changed

+1661
-9
lines changed

‎.gitignore‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
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+
18
# Byte-compiled / optimized / DLL files
29
__pycache__/
310
*.py[cod]
@@ -20,7 +27,6 @@ parts/
2027
sdist/
2128
var/
2229
wheels/
23-
pip-wheel-metadata/
2430
share/python-wheels/
2531
*.egg-info/
2632
.installed.cfg
@@ -50,6 +56,7 @@ coverage.xml
5056
*.py,cover
5157
.hypothesis/
5258
.pytest_cache/
59+
cover/
5360

5461
# Translations
5562
*.mo
@@ -72,6 +79,7 @@ instance/
7279
docs/_build/
7380

7481
# PyBuilder
82+
.pybuilder/
7583
target/
7684

7785
# Jupyter Notebook
@@ -82,6 +90,8 @@ profile_default/
8290
ipython_config.py
8391

8492
# 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:
8595
.python-version
8696

8797
# pipenv
@@ -128,10 +138,24 @@ dmypy.json
128138
# Pyre type checker
129139
.pyre/
130140

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+
131151
# Editors
132152
.vscode/
133153

134154
# conda build results
135155
conda_build/
136156
conda_packages/
137157

158+
# Sphinx documentation
159+
docs/html/
160+
docs/source/_build/
161+
docs/source/components.rst

‎README.md‎

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

3+
# the _labscript suite_ » runviewer
34

4-
The runviewer Python program allows you to visualise a shot compiled by labscript. runviewer is designed to show you what you have commanded the hardware to do throughout the experiment shot, by plotting traces of outputs and inputs. These traces are reverse engineered from the hardware instructions produced by labscript, and provide a faithful representation of what the hardware has been commanded to do.
5+
### Visualize hardware-timed experiment instructions
56

6-
(
7-
[view on Bitbucket](https://bitbucket.org/labscript_suite/runviewer)
8-
)
7+
[![Actions Status](https://github.com/labscript-suite/runviewer/workflows/Build%20and%20Release/badge.svg?branch=maintenance%2F3.0.x)](https://github.com/labscript-suite/runviewer/actions)
8+
[![License](https://img.shields.io/pypi/l/runviewer.svg)](https://github.com/labscriptsuite/runviewer/raw/master/LICENSE.txt)
9+
[![Python Version](https://img.shields.io/pypi/pyversions/runviewer.svg)](https://python.org)
10+
[![PyPI](https://img.shields.io/pypi/v/runviewer.svg)](https://pypi.org/project/runviewer)
11+
[![Conda Version](https://img.shields.io/conda/v/labscript-suite/runviewer)](https://anaconda.org/labscript-suite/runviewer)
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)-->
914

10-
* For install instructions, see the [labscript suite install guide](https://bitbucket.org/labscript_suite/install-guide)
15+
16+
**runviewer** is a graphical interface for visualising hardware-timed experiments composed using the [*labscript suite*](https://github.com/labscript-suite/labscript-suite). runviewer shows you what you have commanded the hardware to do throughout an experiment shot, by plotting annotated, interactive timeseries of outputs and inputs. These traces are reverse engineered (uncompiled) from the hardware instructions produced by labscript, and provide a faithful representation of what the hardware has been commanded to do.
17+
18+
## Installation
19+
20+
runviewer 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 %}

0 commit comments

Comments
 (0)