Skip to content

Commit

Permalink
Populated README.md with styling, iconogrpahy, prose, and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
rpanderson committed Jun 16, 2020
1 parent 06e430b commit fe40066
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,34 @@
# BLACS
<img src="https://raw.githubusercontent.com/labscript-suite/labscript-suite/master/art/blacs_32nx32n.svg" height="64" alt="the labscript suite – blacs" align="right">

Part of the labscript suite, provides an interface to hardware used to control a buffered experiment. It manages a queue of shots to be run as well as providing manual control over devices between shots.
# the _labscript suite_ » blacs

(
[view on Bitbucket](https://bitbucket.org/labscript_suite/blacs)
)
### Graphical interface to scientific instruments and experiment supervision

* For install instructions, see the [labscript suite install guide](https://bitbucket.org/labscript_suite/install-guide)
___

[![Actions Status](https://github.com/labscript-suite/blacs/workflows/Build%20and%20Release/badge.svg?branch=maintenance%2F3.0.x)](https://github.com/labscript-suite/blacs/actions)
[![License](https://img.shields.io/pypi/l/blacs.svg)](https://github.com/labscript-suite/blacs/raw/master/LICENSE.txt)
[![Python Version](https://img.shields.io/pypi/pyversions/blacs.svg)](https://python.org)
[![PyPI](https://img.shields.io/pypi/v/blacs.svg)](https://pypi.org/project/blacs)
[![Conda Version](https://img.shields.io/conda/v/labscript-suite/lyse)](https://anaconda.org/labscript-suite/blacs)
[![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)-->

**blacs** supervises the execution of experiments controlled by the [*labscript suite*](https://github.com/labscript-suite/labscript-suite). It manages experiment queuing and hardware-timed execution, and provides manual control over devices between experiment shots.


## Installation

blacs can be installed on Python 3.6 and later from [PyPI](https://pypi.org/user/labscript-suite):

```console
$ pip install blacs
```

Or from [Anaconda Cloud](https://anaconda.org/labscript-suite):

```console
$ conda install -c labscript-suite blacs
```

For complete installation instructions, please see the _labscript suite_ [installation guide](https://docs.labscriptsuite.org/en/latest/installation).

0 comments on commit fe40066

Please sign in to comment.