Merging current state of changes

.gitignore

@@ -4,3 +4,6 @@ output/
 .idea
 .vscode
 .ipynb_checkpoints
+*.pyc
+env
+*.swp

.gitlab-ci.yml

@@ -0,0 +1,149 @@
+# Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+stages:
+  - test
+  - build
+  - deploy
+
+variables:
+  # needed by click library for the tests
+  LC_ALL: "C.UTF-8"
+  LANG: "C.UTF-8"
+
+cache:
+  key: "$CI_COMMIT_REF_SLUG"
+  paths:
+    - .pip
+
+.install_requirements: &install_requirements
+  - DEBIAN_FRONTEND=noninteractive apt-get update && apt-get upgrade -y
+  - DEBIAN_FRONTEND=noninteractive apt-get install python3 git cython python3-pip libspatialindex-dev libgdal-dev -y
+  - pip3 install --cache-dir=.pip -r requirements.txt
+
+verify_python:
+  image: ubuntu:18.04
+  stage: test
+  tags:
+    - group
+  before_script:
+    - *install_requirements
+  script:
+    - python3 -m compileall .
+
+python_pycodestyle:
+  image: ubuntu:18.04
+  stage: test
+  # TODO: fix code to fit with PEP8 guidelines
+  allow_failure: true
+  tags:
+    - group
+  before_script:
+    - *install_requirements
+    - pip3 install --cache-dir=.pip pycodestyle
+  script:
+    - shopt -s globstar && pycodestyle {,**/}*.py
+
+python_pylint:
+  image: ubuntu:18.04
+  stage: test
+  # TODO: fix code to get a better pylint rating
+  allow_failure: true
+  tags:
+    - group
+  before_script:
+    - *install_requirements
+    - pip3 install --cache-dir=.pip pylint
+  script:
+    - shopt -s globstar && pylint --fail-under=8 {,**/}*.py
+
+python_black:
+  image: ubuntu:18.04
+  stage: test
+  tags:
+    - group
+  before_script:
+    - *install_requirements
+    - pip3 install --cache-dir=.pip black==22.3.0
+  script:
+    - black -l 79 --check .
+
+run_tests:
+  image: ubuntu:18.04
+  stage: test
+  tags:
+    - group
+  before_script:
+    - *install_requirements
+  script:
+    - python3 test_cmd.py
+
+verify_json:
+  stage: test
+  image: registry.gitlab.com/pipeline-components/jsonlint:0.12.0
+  cache: {}
+  script:
+    - |
+      find . -not -path './.git/*' -name '*.json' -type f -print0 |
+      parallel --will-cite -k -0 -n1 jsonlint -q
+
+dockerbuild_latest:
+  image: docker/compose:1.29.2
+  stage: build
+  cache: {}
+  tags:
+    - group
+  script:
+    - docker build -t assetmaster:latest -f metadata/Dockerfile .
+
+    # push latest image to Docker Hub
+    - docker tag assetmaster:latest gfzriesgos/assetmaster:latest
+    - docker login -u ${DOCKERHUB_USER} -p ${DOCKERHUB_PASSWORD}
+    - docker push gfzriesgos/assetmaster:latest
+
+    # push latest image to GitLab Container Registry
+    - docker tag assetmaster:latest git.gfz-potsdam.de:5000/id2/riesgos/assetmaster:latest
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker push git.gfz-potsdam.de:5000/id2/riesgos/assetmaster:latest
+
+dockerbuild_tagged:
+  image: docker/compose:1.29.2
+  stage: build
+  cache: {}
+  tags:
+    - group
+  rules:
+    - if: $CI_COMMIT_TAG
+  script:
+    - sed -i -e "s@:latest@:${CI_COMMIT_TAG}@g" metadata/assetmaster.json
+    - docker build -t assetmaster:${CI_COMMIT_TAG} -f metadata/Dockerfile .
+
+    # push image to Docker Hub
+    - docker tag assetmaster:${CI_COMMIT_TAG} gfzriesgos/assetmaster:${CI_COMMIT_TAG}
+    - docker login -u ${DOCKERHUB_USER} -p ${DOCKERHUB_PASSWORD}
+    - docker push gfzriesgos/assetmaster:${CI_COMMIT_TAG}
+
+    # push image to GitLab Container Registry
+    - docker tag assetmaster:${CI_COMMIT_TAG} git.gfz-potsdam.de:5000/id2/riesgos/assetmaster:${CI_COMMIT_TAG}
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker push git.gfz-potsdam.de:5000/id2/riesgos/assetmaster:${CI_COMMIT_TAG}
+
+deploy_latest:
+  stage: deploy
+  variables:
+    DEPLOY_LATEST_IMAGES: "true"
+  trigger:
+    project: id2/riesgos/gfz-riesgos-wps-repository
+    branch: master
+    strategy: depend

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [2019] [GFZ Potsdam]
+   Copyright [2021] [Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,10 +1,15 @@
 # Assetmaster
+
 web service providing exposure models upon geographical query - RIESGOS project
 
 This program reads an exposure model from a geopackage (.gpkg) file and provides a user with a portion of the model according to a bounding box provided (lonminm, lonmax, latmin, latmax), a query mode ("intersects" or "within").
 A given exposure vulnerability schema can be queried (currently only the "SARA_v1.0" model for Chile is implemented)
 A given set of assets can be specified (currently only "res" for residential buildings)
 
+### Citation
+
+Pittore, Massimiliano; Gomez-Zapata, Juan Camilo; Brinckmann, Nils; Rüster, Matthias (2021): Assetmaster and Modelprop: web services to serve building exposure models and fragility functions for physical vulnerability to natural-hazards. V. 1.0. GFZ Data Services. https://doi.org/10.5880/riesgos.2021.005
+
 ### example (command line)
 python3.7 assetmaster.py -71.8 -71.4 -33.2 -33.0 SARA_v1.0 res intersects
 
@@ -17,3 +22,32 @@ python3.7 assetmaster.py -71.8 -71.4 -33.2 -33.0 SARA_v1.0 res intersects
 
 ### Process configuration 
 The .json file providing the basic process configuration is in the *metadata* folder
+
+### How to add data for other countries
+
+If you just want to provide data for other countries you can add gpkg files
+in the schemas/`<your schema here>`/ folders.
+
+At least for the gpkg folder there is no naming convention inside of this folders
+anymore.
+
+The current version for SARA and Chile is the `schemas/SARA_v1.0/SARA_v1.0_data.gpkg`.
+You can replace this with a new file.
+
+For adding the peru exposure model for peru you can just insert the gpkg file into
+the `schemas/SARA_v1/` folder. But please make sure that the data there matches the very
+same structure of the existing gpkg data.
+
+### Copyright & License
+Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+### Project
+
+Deus was developed in the scope of the RIESGOS project:
+Multi-Risk Analysis and Information System Components for the Andes Region (https://www.riesgos.de/en)

__init__.py

@@ -0,0 +1,7 @@
+# Copyright © 2021 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.