v0.2.0 Docker Support

Change Log

0.2.0

NEW

• The tool is now also available as a Docker Image,
  see a3a8f9f.

---

🐋 HOW TO RUN USING DOCKER

The following example shows how Docker can be applied in most simple use cases:

1. Create a working directory, such as <WORKING_DIR>. This shall be the default project directory in the following steps.

   mkdir <WORKING_DIR>

2. Create a configuration file:

   mkdir <WORKING_DIR>/config
   touch <WORKING_DIR>/config/config.txt

   The instructions and examples of such configuration files are given here.

3. Create a directory to store input CityGML datasets:

   mkdir <WORKING_DIR>/input

   Then copy the files that need to be matched inside this directory.

4. Pull the latest docker image:

   docker pull sonnguyentum/citygml-change-detection[:Tag]

   where [:Tag] is the version of the Docker image. The list of all tags is available here.

5. Run the Docker container based on the pulled image:

   docker run --rm --name citygml-change-detection -it \
     -v <WORKING_DIR>/config:/citygml-change-detection/config \
     -v <WORKING_DIR>/input:/citygml-change-detection/input \
     -v <WORKING_DIR>/output:/citygml-change-detection/output \
     sonnguyentum/citygml-change-detection[:Tag] \
     "-SETTINGS=<WORKING_DIR>/config/config.txt"

   The argument --rm means that the Docker container is temporary and shall be automatically removed afterwards.

6. The change detection results are now stored in the directories <WORKING_DIR>/output.

🌊 HOW TO BUILD AND PUBLISH IN DOCKER

The Dockerfile used to build the Docker image mentioned above is also included. To build the image, change to the project directory and execute the following command:

docker build -t citygml-change-detection .

OR include a tag to publish in DockerHub:

docker build -t <username>/<repository>[:Tag] .
docker push <username>/<repository>[:Tag]