Skip to content

Commit

Permalink
added readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
amit lissack committed May 27, 2021
1 parent 8a8b5e7 commit 4b0fb37
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 5 deletions.
32 changes: 27 additions & 5 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
.git
.cache
dist
build

./api-server
./app
./labware-library
Expand All @@ -14,3 +9,30 @@ build
./app-shell
./update-server
./step-generation

.pytest_cache
.flake8
.idea
.pypy_cache
dist
build
yarn.lock
Pipfile.lock

__pycache__
*.pyc
*.pyo
*.pyd
.Python
env
pip-log.txt
pip-delete-this-directory.txt
.tox
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
*.log
.git
28 changes: 28 additions & 0 deletions DOCKER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Docker Guide
=======================
Included in this repo are the tools to run a containerized Opentrons robot stack in docker.

This includes the `robot-server` connected to the hardware emulation application. The emulation application includes the Smoothie and magnetic, temperature, and thermocycler modules.

Requirements
------------------
- A clone of this repo.
- An installation [docker](https://docs.docker.com/get-docker/)
- An installation of [docker-compose](https://docs.docker.com/compose/install/)

How to use
--------------
Start a terminal and change directory to the root of this repo.

1) Build
Enter ```docker-compose build --force-rm``` at the terminal.

2) Run
Enter ```docker-compose up``` at the terminal. *The build and run stages can be combined ```docker-compose up --build```.*

3) Start the Opentrons application. The docker container will appear as `dev`. Connect and run just as you would on a robot.

Known Issues
---
- Pipettes cannot be changed at run time.
- Pipettes are fixed as `p20_multi_v2.0` on the left mount and `p20_single_v2.0` on the right.

0 comments on commit 4b0fb37

Please sign in to comment.