Skip to content

Commit a54f961

Browse files
committed
Populated README.md with styling, iconogrpahy, prose, and badges
1 parent 7d94422 commit a54f961

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
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+
___
98

10-
* For install instructions, see the [labscript suite install guide](https://bitbucket.org/labscript_suite/install-guide)
9+
[![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)
10+
[![License](https://img.shields.io/pypi/l/runviewer.svg)](https://github.com/rpanderson/runviewer/raw/master/LICENSE.txt)
11+
[![Python Version](https://img.shields.io/pypi/pyversions/runviewer.svg)](https://python.org)
12+
[![PyPI](https://img.shields.io/pypi/v/runviewer.svg)](https://pypi.org/project/runviewer)
13+
[![Conda Version](https://img.shields.io/conda/v/labscript-suite/runviewer)](https://anaconda.org/labscript-suite/runviewer)
14+
[![Google Group](https://img.shields.io/badge/Google%20Group-labscriptsuite-blue.svg)](https://groups.google.com/forum/#!forum/labscriptsuite)
15+
<!--[![DOI](http://img.shields.io/badge/DOI-10.1063%2F1.4817213-0F79D0.svg)](https://doi.org/10.1063/1.4817213)-->
16+
17+
**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.
18+
19+
For installation instructions, please see the _labscript suite_ [installation guide](https://docs.labscriptsuite.org/en/latest/installation).

0 commit comments

Comments
 (0)