Skip to content

Commit ad4402a

Browse files
committed
pulled master
2 parents 4cd476f + 4a99a53 commit ad4402a

File tree

5 files changed

+30
-4
lines changed

5 files changed

+30
-4
lines changed

README.md

+26-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# opentrons_functions
2-
A collection of functions compatible with the Opentrons API
2+
A collection of functions compatible with the Opentrons API.
3+
4+
## Installation
5+
6+
To install on your Unix-based machine, you can simply point `pip` to this git repository:
7+
8+
```{bash}
9+
pip install git+https://github.com/tanaes/opentrons_functions.git
10+
```
11+
12+
The easiest way to install this library is via the Jupyter Notebook server on your OT-2. Follow the [instructions on the Opentrons site](https://support.opentrons.com/en/articles/1795367-running-the-robot-using-jupyter-notebook) for connecting.
13+
14+
Then, use the Jupyter interface to launch a new terminal. On the right side of the screen, click the 'New' button, and select 'Terminal.' This will give you terminal access to the OT-2 Linux system.
15+
16+
![jupyter new terminal interface screenshot](./doc/assets/jupyter_new_terminal.png)
17+
18+
The OT-2 does not have `git` installed, so you must point `pip` to one of the [release](https://github.com/tanaes/opentrons_functions/releases) tarballs instead. For example:
19+
20+
```{bash}
21+
pip install https://github.com/tanaes/opentrons_functions/archive/v0.1.0-pre
22+
release.tar.gz
23+
```
24+
25+
If this is successful, you should see a long dialogue of dependencies (most or all should already be installed):
26+
27+
![pip installation screenshot](./doc/assets/jupyter_pip_log.png)

doc/assets/jupyter_new_terminal.png

26.4 KB
Loading

doc/assets/jupyter_pip_log.png

344 KB
Loading

setup.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name='opentrons_functions',
5-
version='0.1.0',
5+
version='0.2.0',
66
description='A collection of functions compatible with the Opentrons API',
77
url='https://github.com/tanaes/opentrons_functions',
88
author='Jon G Sanders',
@@ -20,6 +20,7 @@
2020
'Operating System :: POSIX :: Linux',
2121
'Operating System :: MacOS :: MacOS X'
2222
'Programming Language :: Python :: 3.5',
23-
'Programming Language :: Python :: 3.6'
23+
'Programming Language :: Python :: 3.6',
24+
'Programming Language :: Python :: 3.7'
2425
],
2526
)

tests/test_util.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from opentrons_functions.util import (odd_or_even)
1+
from opentrons_functions.util import odd_or_even
22

33

44
def test_odd_or_even():

0 commit comments

Comments
 (0)