Skip to content

Commit

Permalink
Merge pull request #35 from broadinstitute/update-readme
Browse files Browse the repository at this point in the history
Update description, tutorial, and examples in README

This makes some major changes to the README, including:
* Updating the acronym title
* Rewriting the description of ADAPT
* Rearranging the 'Using ADAPT' section and rewriting parts of it
* Updating the main example to use the `maximize-activity` objective
* Clarifying that the first example is a very basic use case
* Adding a section for information about questions
* Adding a placeholder for information about citing the preprint
  • Loading branch information
haydenm authored Nov 25, 2020
2 parents 86cda7e + 5522248 commit 61dc61c
Show file tree
Hide file tree
Showing 3 changed files with 331 additions and 157 deletions.
9 changes: 5 additions & 4 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
FROM python:3.8.5-slim

LABEL maintainer='Priya Pillai <ppillai@broadinstitute.org>'

# to build:
# docker build . -t adapt
#
# to run:
# docker run --rm [IMAGE-ID] "[COMMAND]"
#
# to run with memo:
# docker run --rm -v /path/to/memo/on/host:/memo <image_ID> "design.py subcommands"
# docker run --rm -v /path/to/memo/on/host:/memo [IMAGE-ID] "[COMMAND]"
#
# to run interactively:
# docker run --rm -it <image_ID>
# docker run --rm -it [IMAGE-ID]
#

ENV \
Expand Down
Loading

0 comments on commit 61dc61c

Please sign in to comment.