Skip to content
Snippets Groups Projects
Commit ff6555f1 authored by Robert Butora's avatar Robert Butora
Browse files

README: re-phrase text to have the style as vlkb-soda

parent 606bec20
No related branches found
No related tags found
No related merge requests found
## vlkb-siav2 ## vlkb-siav2
is a web-application to discover astronomical data (supports FITS-files) and described in a VO ObsTAP table is a web-application to discover astronomical data (supports FITS-files) and described in a [VO ObsTAP table](https://ivoa.net/documents/ObsCore).
(https://ivoa.net/documents/ObsCore). It implements IVOA recommendation [SIA version 2](https://ivoa.net/documents/SIA) with optional VLKB-specific features:
It implements the SIA version 2, IVOA recommendation (https://ivoa.net/documents/SIA) with optional VLKB-specific features:
- provides overlap code - provides overlap code
- the filtering paramters (POS, BAND) can be given in GALACTIC and VELO-LSRK-km/s coordinates systems - the filtering paramters (POS, BAND) can be given in GALACTIC and VELO-LSRK-km/s coordinates systems
When used with [**vlkb-soda**](https://ict.inaf.it/gitlab/ViaLactea/vlkb-soda) they provide complete data-discovery and access solution.
## Launching the service
The service consists of **vlkb-siav2** web-application and associated **vlkb-obscore** command line tool to create the ObsTAP table from FITS-files headers. The service consists of **vlkb-siav2** web-application and associated **vlkb-obscore** command line tool to create the ObsTAP table from FITS-files headers.
The vlkb-obscore cli is available from https://ict.inaf.it/gitlab/butora/vlkb-datasets . The service may be launched by docker compose with [compose.yaml](./docker/example-compose.yaml). The database service is not needed, running database instance may de set directly by DB_URI parameters. Additionaly choose context root and point to the data access service.
Dockerized version of the web-app is available from https://ict.inaf.it/gitlab/butora/vlkb-datasets-docker . To check the service status access the availability endpoint:
```bash
curl --get http://localhost:8004/vlkb/datasets/availability
```
## Endpoints
- **availability** is a [VOSI](https://ivoa.net/documents/VOSI/20170524/REC-VOSI-1.1.html) end-point and returns information whether the service is active
- **capabilities** is a [VOSI](https://ivoa.net/documents/VOSI/20170524/REC-VOSI-1.1.html) end-point which describes service' functions and paramters
- **siav2** synchronous end-point provides [SIAv2](https://ivoa.net/documents/SIA) service; responds with a [VOTable](https://ivoa.net/documents/VOTable/).
## Docker image ## Docker image
To configure the application choose a context-root where the SIAv2 can be accessed, The vlkb-siav2 is available from the gitlab repositary of this project.
provide database URI which points to the ObsTAP table and provide URL for data-access
(typically a SODA service).
Example compose.yaml entry for VLKB-SIAv2:
```yaml
vlkb-siav2:
container_name: vlkb-siav2
image: git.ia2.inaf.it:5050/vialactea/vlkb-siav2/siav2:1.6
ports:
- 8080:8080
environment:
- DISCOVERY_CONTEXT_ROOT=vlkb#datasets#siav2
- DB_URI=jdbc:postgresql://vlkb-db:5432/vialactea
- DB_USERNAME=vialactea
- DB_PASSWORD=ia2vlkb
- CUTOUT_SERVICE_URL=http://vlkb-devel.ia2.inaf.it:8004/vlkb/datasets/soda
```
## Installation Configuration parameters are set by these docker environment variables:
There is a war-package for the search web-application and the package (deb or rpm) with linux
executable for Debian, CentOS and Fedora:
- vlkb-search-X.Y.Z.war | parameter | description |
- vlkb-obscore-X.Y.Z.deb|.rpm |---------|--------------|
| **DISCOVERY_CONTEXT_ROOT** | root of the vlkb-soda end-points |
| **DB_URI** | DB which holds ObsTAP table |
| **DB_USERNAME** | DB user which has access to ObsTAP |
| **DB_PASSWORD** | and user's password |
| **CUTOUT_SERVICE_URL** | URL of a SODA service presented in the response |
To download version X.Y, add one of the above package names to
```bash ## vlkb-obscore
curl -O --header "PRIVATE-TOKEN: <security-token>" "https://ict.inaf.it/gitlab/api/v4/projects/79/packages/generic/vlkb-datasets/X.Y/vlkb-obscore-<version>.{deb|rpm}"
``` There are binary packages for Debian, CentOS and Fedora. All cli tools are currenlty distributed with the **vlkb-soda** (and not vlkb-siav2) and are hosted in vlkb-soda gitlab repository. The ObsTAP-tool package is:
- vlkb-obscore-X.Y.Z.deb|.rpm
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment