diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..48f43f4 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +# set base image +FROM python:3.7-slim + +# set the working directory in the container +WORKDIR /app + +# install fawkes +RUN pip install fawkes + +# downgrade h5py: https://github.com/Shawn-Shan/fawkes/issues/75 +RUN pip install --upgrade h5py==2.10.0 + +# copy the files you want to edit with fawkes +COPY imgs imgs \ No newline at end of file diff --git a/README.md b/README.md index 0972478..f891806 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,17 @@ pip install fawkes If you don't have root privilege, please try to install on user namespace: `pip install --user fawkes`. +## Installation and Usage with Docker + +- clone this repository: `git clone [url]` +- go into cloned repository: `cd fawkes` +- create `/imgs` folder in root folder: `mkdir imgs` +- build docker image in root folder: `docker build -t fawkes .` +- run container: `docker run -it fawkes sh` +- run your fawkes command, e.g. `fawkes -d ./imgs --mode min` +- exit from your container: `exit` +- find your container id: `docker container ls --all` +- copy the created data to your local machine: `docker cp [container-id]:/app/imgs ~/output-from-fawkes` Academic Research Usage -----------------------