Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maartenplieger committed Oct 23, 2024
1 parent 703ae35 commit ac1e714
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 12 deletions.
3 changes: 2 additions & 1 deletion doc/Running.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ If you now see the viewer, you have succesfully started the adaguc-server.

Scan with the adaguc-server container:
```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh <optional datasetname>
docker exec -i -t my-adaguc-server /adaguc/scan.sh -l
docker exec -i -t my-adaguc-server /adaguc/scan.sh <optional -d datasetname>
```

## Visit the webservice:
Expand Down
6 changes: 2 additions & 4 deletions doc/info/Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ docker-compose build
docker-compose up -d && sleep 10
1. Scan datasets:
docker exec -i -t my-adaguc-server
/adaguc/adaguc-server-updatedatasets.sh
docker exec -i -t my-adaguc-server /adaguc/scan.sh
<!-- -->
Expand Down Expand Up @@ -104,8 +103,7 @@ mkdir \$HOME/adaguc-datasets
<!-- -->
1. Scan datasets:
docker exec -i -t my-adaguc-server
/adaguc/adaguc-server-updatedatasets.sh
docker exec -i -t my-adaguc-server /adaguc/scan.sh
<!-- -->
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorials/Configure_EDR_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ parameter_names": {
## Step 3: Scan the new data

```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh edr
docker exec -i -t my-adaguc-server /adaguc/scan.sh -d edr
```

## Step 4: Check if the EDR endpoint works
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ This file is called a dataset configuration and is normally stored in the adaguc
# Step 4: Scan the files

```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh RAD_NL25_PCP_CM
docker exec -i -t my-adaguc-server /adaguc/scan.sh -d RAD_NL25_PCP_CM
```

## Output:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ You could copy these files from [here - python/examples/rundataset/data/sequence
When everything is configured, you are ready to scan (or ingest) the files, this can be done with the following command:

```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh mymonthlyconfig
docker exec -i -t my-adaguc-server /adaguc/scan.sh -d mymonthlyconfig
```

It should print something like:

```
$ docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh mymonthlyconfig
$ docker exec -i -t my-adaguc-server /adaguc/scan.sh -d mymonthlyconfig
Using adagucserver from /adaguc/adaguc-server-master
Using config from /adaguc/adaguc-server-config.xml
Expand Down Expand Up @@ -76,13 +76,13 @@ If you would like to add a single file in the configured data directory,
you can do:

```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh mymonthlyconfig apr.nc
docker exec -i -t my-adaguc-server /adaguc/scan.sh -d mymonthlyconfig apr.nc
```

If you would like to scan specific files in a certain subdirectory of
the configured data directory, you can do:
```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh mymonthlyconfig 2013
docker exec -i -t my-adaguc-server /adaguc/scan.sh -d mymonthlyconfig 2013
```

This adds the files which are located in the given subdirectory. If
Expand All @@ -95,7 +95,7 @@ If you would like to remove files from the service, because they do not
exist anymore on the filesystem or for any other reason, you can call
updatedb again with only the dataset:
```
docker exec -i -t my-adaguc-server /adaguc/adaguc-server-updatedatasets.sh mymonthlyconfig
docker exec -i -t my-adaguc-server /adaguc/scan.sh -d mymonthlyconfig
```

This checks if files are present in adaguc-server database but not on the filesystem. It will also check if files have been updated.

0 comments on commit ac1e714

Please sign in to comment.