Merge pull request #3 from jmsaurel/main

Update README to use docker-compose

Author: PBoissier

README.md

@@ -1,5 +1,5 @@
 # seiscomp-gui-docker
-SeisComP scolv GUI utility in a docker container
+SeisComP GUI utilities in a docker container
 
 ## Mac install
 
@@ -24,61 +24,66 @@ Start Docker Desktop (Applications folder) : it will start the docker daemon.
 
 ## Building and running Docker container
 
-### Build Docker image
+### Build image and create container
 
-#### On Mac with an Apple Silicon (ARM64) processor
+#### Update configuration
+The file `compose.yaml` contains instructions to mount host
+directories on the container.
+Typically, when using SeiSComP GUI, you would need :
+ * a directory containing `.cfg` personal configuration files for each application
+ * a directory containing map tiles
+ * directories containing travel time files for locators
 
-Docker Desktop can use Rosetta 2 to emulate x86_64 images on Apple Silicon Macs. Here's how to enable it :
+By default, configuration files are expected on `$HOME/seiscomp-gui/cfg` on the host computer. They are mounted on `$HOME/.seiscomp` in the container.
+By default, map tiles directory is expected on `$HOME/seiscomp-gui/maps` on the host computer. It is mounted on `/opt/seiscomp/share/maps` in the container.
+By default, NonLinLoc configuration and time travel files are expected on `$HOME/seiscomp-gui/nll` on the host computer. It is mounted on `/opt/seiscomp/share/nll` in the container.
+By default, Hypo71PC configuration files and velocity models are expected to be found on `$HOME/seiscomp-gui/hypo71` on the host computer. It is mounted on `/opt/seiscomp/share/hypo71` in the container.
 
-- Open Docker Desktop.
-- Go to Settings > General.
-- Enable the option "Use Rosetta for x86/amd64 emulation on Apple Silicon".
+You can update the host path for each volume or comment the unused ones in the `compose.yaml` file, section `volumes`.
 
-Then start building the image :
+#### Create image and container
 
 ```bash
-docker buildx build -t seiscomp-version6:latest --platform linux/amd64 .
+docker compose create
 ```
 
-#### On Mac with an Intel processor
+### Run the container
 
 ```bash
-docker build -t seiscomp-version6:latest .
+docker compose start
 ```
 
-### Create and start container
-
-#### Simple container without configuration
-
-Create and start a simple container without base configuration :
+### Stop the container
 
 ```bash
-docker run -d -p 2222:22 --name scolv seiscomp-version6:latest          
+docker compose stop
 ```
 
-#### Pre-configured environment
-
-You can create a "seiscomp" folder and mount it on the container. For example, assuming you have a folder containing the nll configuration and OpenStreetMap maps on your Mac's hard drive in the directory /HOST/PATH/TO/seiscomp/share/, you can create and start a preconfigured container:
-
-```bash
-docker run -d -p 2222:22 \
-           -v /HOST/PATH/TO/seiscomp/share/nll:/opt/seiscomp/share/nll \
-           -v /HOST/PATH/TO/seiscomp/share/maps/OCMap:/opt/seiscomp/share/maps/OCMap \
-           -v /HOST/PATH/TO/seiscomp/etc:/home/sysop/.seiscomp \
-           --name scolv seiscomp-version6:latest
-```
+## Running SeisComP GUI app
 
 ### Connect to container with SSH
 
 ```bash
 ssh -Y -p 2222 sysop@localhost
 ```
-### Start scolv
+### Start scolv (same applies for any other SeisComP GUI)
 
+Without option and with the default container configutation, scolv will use `$HOME/seiscomp-gui/cfg/scolv.cfg` file from the host.
 ```bash
 scolv
 ```
 
+Scolv can be launched to point to a specific configuration file from `$HOME/seiscomp-gui/cfg/` directory on the host.
+```bash
+scolv --config-file $HOME/.seiscomp/my_scolv_config_file.cfg
+```
+### List of SeisComP GUI
+* scolv : locator interface
+* scrttv : waveform display interface
+* scmv : station map interface
+* scesv : event interface
+* scqcv : station quality check interface
+
 ## Credits
 
 This project was inspired by [Fred Massin](https://github.com/FMassin). Many thanks!!

compose.yaml

@@ -6,7 +6,7 @@ services:
         ports:
             - "2224:22"
         volumes:
-            - $HOME/seiscomp-gui/cfg:/home/sysop/.seiscomp/:ro
+            - $HOME/seiscomp-gui/cfg:/home/sysop/.seiscomp:rw
             - $HOME/seiscomp-gui/maps:/opt/seiscomp/share/maps:ro
             - $HOME/seiscomp-gui/nll:/opt/seiscomp/share/nll:rw
             - $HOME/seiscomp-gui/hypo71:/opt/seiscomp/share/hypo71:rw