Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Adding instructions for using the pre-built docker image.
  • Loading branch information
sjayellis authored Dec 18, 2023
1 parent 623c68a commit 6dbe4a1
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,14 @@


## Build/Run Docker image for Molssi Python Best practices workshop
1. `docker build -t molecool_env .`
2. `docker run -it molecool_env`
The dockerfile can be used to build a docker image. Clone this repository and navigate using the command line (a terminal) to the root folder of the repository.
Run the following command to build the docker image:
`docker build -t python-best-practices-container .`
After it has been built, you can run the resulting image as an interactive terminal using
`docker run -it python-best-practices-container`

The repository also has a pre-built image that can be pulled to your local computer using Docker.
The container can be found in the packages section of this repository, or pulled using:
`docker pull ghcr.io/molssi-education/python-best-practices-container:latest`
Once the image is stored locally, you can the following command to run the image as if you had built it.
`docker run -it ghcr.io/molssi-education/python-best-practices-container:latest`

0 comments on commit 6dbe4a1

Please sign in to comment.