README.md

Table of Contents generated with DocToc

• ee-services - Early-est Services
  • Introduction
  • Quickstart
    • Get Docker image
      • 1) Get built image from DockerHub (preferred)
      • 2) Build by yourself
    • Run as a service
  • Test ee-services as a stand alone script
  • Contribute
  • Authors

ee-services - Early-est Services

Introduction

This project implement the web services exposed by early-est INGV customization

Quickstart

Get Docker image

To obtain ee-services docker image, you have two options:

1) Get built image from DockerHub (preferred)

Get the last built image from DockerHub repository:

docker pull ingv/ee-services:latest

2) Build by yourself

Clone the git repositry:

git clone https://github.com/INGV/ee-services.git
cd ee-services

build the image:

docker build --tag ingv/ee-services .

in case of errors, try:

docker build --no-cache --pull --tag ingv/ee-services . 

Run as a service

run the container in daemon (-d) mode:

docker run -it --rm --name ee-services -p 8383:5000 -d ingv/ee-services
docker exec -i ee-services tail -f /opt/log/ee-services.log

Choose your preferred port as an alternative to 8383

Then test access to: http://localhost:8383/ for swagger API documentation

Examples of URL:

• http://localhost:4300/api/make_ee_ellipsoid?lat=40.6&lon=13.2&delta=1&xx=111&xy=55.5&yy=111
  

Test ee-services as a stand alone script

If you have cloned the project, you can check the evaluator engine from command line. To do this you need python3.x installed on your machine and also some python libraries:

pip install -r requirements.txt
python main/api/services.py --help

Here is an example of launch:

python main/api/services.py --lat 35 --lon 10 --delta 50 --covxx 36.3027 --covxy -0.0486165 --covyy 5.0177

Contribute

Thanks to your contributions!

Here is a list of users who already contributed to this repository:

Authors

(c) 2023 Sergio Bruni sergio.bruni[at]ingv.it
(c) 2023 Fabrizio Bernardi fabrizio.bernardi[at]ingv.it
(c) 2023 Valentino Lauciani valentino.lauciani[at]ingv.it

Istituto Nazionale di Geofisica e Vulcanologia, Italia