Skip to content

Commit

Permalink
README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
sam210723 committed Nov 19, 2019
1 parent b95702a commit 41607ad
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# wavebin

**wavebin** is a tool for viewing waveform files (``.bin``) generated by Keysight oscilloscopes.

![Screenshot](https://github.com/sam210723/wavebin/raw/master/screenshot.png)

Currently **wavebin** has been tested with files from a [**DSO-X 1102G**](https://www.keysight.com/en/pdx-2766207-pn-DSOX1102G/oscilloscope-70-100-mhz-2-analog-channels). If you have access to waveform files from other Keysight oscilloscopes, please submit them for testing through the [Sample Waveforms issue](https://github.com/sam210723/wavebin/issues/1).

## Getting Started

**wavebin** is available through the [Python Package Index](https://pypi.org/project/wavebin/). To install **wavebin** and its dependencies ([magnitude](https://pypi.org/project/magnitude/), [numpy](https://numpy.org/), [pyqt5](https://pypi.org/project/PyQt5/), [pyqtgraph](http://www.pyqtgraph.org/)), run the following command:

```
Expand All @@ -18,7 +20,7 @@ To view a waveform with **wavebin**, run the following command:
python -m wavebin [PATH TO BIN FILE]
```

Use the``-v`` option to see detailed information about the waveform file:
Use the ``-v`` option to see detailed information about the waveform file:

```
wavebin v1.0
Expand Down Expand Up @@ -51,5 +53,6 @@ Rendering 1 waveform...
```

## Resources
- [FaustinCarter/agilent_read_binary](https://github.com/FaustinCarter/agilent_read_binary)
- [yodalee/keysightBin](https://github.com/yodalee/keysightBin/)

- [FaustinCarter/agilent_read_binary](https://github.com/FaustinCarter/agilent_read_binary)
- [yodalee/keysightBin](https://github.com/yodalee/keysightBin/)

0 comments on commit 41607ad

Please sign in to comment.