Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rugeli committed Jul 29, 2024
1 parent 055471a commit 1461634
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,5 +92,14 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the
* Reach out to the code owner for the necessary credentials.
* Set up an `.env` file as instructed.

### Docker

1. Install [docker](https://docs.docker.com/v17.09/engine/installation/)
2. Clone the repository locally, if you haven't already: `git clone https://github.com/mesoscope/cellpack.git`
3. Ensure that you have valid AWS access key and secret to access the `cellpack-results` S3 bucket, usually stored in a `~/.aws/credentials` file.
4. To build the container, run: `sudo docker build -t cellpack_image .` Include `--build-arg local=True` if running locally, omit if running on an EC2 instance connected to EFS volume
5. To run packings in the container, run: `sudo docker run -v ~/.aws:/root/.aws -e recipe=examples/recipes/v2/one_sphere.json -e config=examples/packing-configs/run.json cellpack_image`
6. Verify that the packing results are saved in the `cellpack-results` S3 bucket. You should see a botocore logging message indicating that the credentials were successfully loaded.

**MIT license**

0 comments on commit 1461634

Please sign in to comment.