Skip to content

Commit b24194b

Browse files
committed
Doc corrections
1 parent adca257 commit b24194b

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# Puzzlepiece
2-
**Puzzlepiece is a GUI-forward Python framework for automating experimental setups.** It focuses on abstracting communication with a piece of hardware into **standard inputs, outputs, and actions**. It then automatically **generates GUI components** for them, minimising the need for boilerplate code. Puzzlepiece allows the user to bring diverse controls into a single, consolidated application, and automate their interaction or experiment using a unified API, either through a built-in script language, or Interactive Python.
2+
**Puzzlepiece is a GUI-forward Python framework for automating experimental setups.** It focuses on abstracting communication with a piece of hardware into **standard inputs, outputs, and actions**. It then automatically **generates GUI components** for them, minimising the need for boilerplate code. Puzzlepiece allows the user to bring diverse controls into a single, consolidated application, and automate their interaction or experiment using a unified API, either by making custom Pieces, or through a built-in script language,
3+
or with Interactive Python.
34

45
Check out the [`examples`](https://github.com/jdranczewski/puzzlepiece/tree/release/examples) folder for how to make an application (a Puzzle), and [`puzzlepiece/pieces/random_number.py`](https://github.com/jdranczewski/puzzlepiece/blob/release/puzzlepiece/pieces/random_number.py) for a simple example Piece. A Piece is a module that does a particular job (talks to a laser, scans a value, ...), and multiple of these brought together make up a Puzzle.
56

6-
Documentation is in progress, available at https://puzzlepiece.readthedocs.io/
7+
You can install puzzlepiece using pip:
8+
```
9+
pip install puzzlepiece
10+
```
711

8-
Currently the main requirement is `pyqtgraph`, and the code accesses whichever Python Qt bindings are installed _through_ `pyqtgraph`. Eventually the code is likely to be migrated to `QtPy`.
12+
See the documentation at https://puzzlepiece.readthedocs.io/ for examples of how to get started.
913

1014
Created by Jakub Dranczewski as part of PhD work supported by the EU ITN EID project CORAL (GA no. 859841).

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ For example we can create a Piece that accesses the RandomNumber generator creat
105105
values = []
106106
# Check this Piece's own param to see how many numbers the user wants
107107
N = self.params["N"].get_value()
108-
for i in range(10):
108+
for i in range(N):
109109
# Get param value from the other Piece
110110
values.append(puzzle["random_number"].params["number"].get_value())
111111
return values

0 commit comments

Comments
 (0)