|
|
:rocket: This is the main repository of ESAP documentation.
|
|
|
:rocket: This is the main repository of ESAP documentation.
|
|
|
|
|
|
:clipboard: Within this documentation we have collected all the fundamental aspects you need to know in order to work with ESAP, from the installation to the customisation of the different services that compose ESAP.
|
|
|
|
|
|
---
|
|
|
|
|
|
ESAP is a suite of online data discovery tools that have been developed for the ESCAPE Science Analysis Platform (ESAP). ESCAPE (European Science Cluster of Astronomy & Particle physics ESFRI research infrastructures) brings together the astronomy, astroparticle and particle physics communities to establish a single collaborative cluster of next generation facilities to build the astronomy and particle physics cell of the European Open Science Cloud.
|
|
|
|
|
|
ESAP is designed to be flexible and extensible with a modular structure that encapsulates its different functional components. The ESAP backend is written in Python using the Django framework and communicates with a Javascript frontend via a RESTful API.
|
|
|
|
|
|
One of the core components of the ESAP is a generic interface that enables discovery of Virtual Observatory (VO) resources by querying the VO registry. Once suitable VO resources have been discovered, ESAP provides a flexible interface to select and retrieve specific subsets of data and stage them for interactive or batch data analysis.
|
|
|
|
|
|
The ESAP data discovery framework also enables support for non-VO data archives with minimal developer effort.
|
|
|
|
|
|
**More info about ESAP**
|
|
|
|
|
|
* ESAP: The ESCAPE ESFRI Science Analysis Platform https://zenodo.org/record/6044637#.Y6BD9eLMLUI
|
|
|
* Discovering data with the ESCAPE Science Analysis Platform: https://adass2020.es/static/ftp/P1-59/P1-59.pdf
|
|
|
|
|
|
**ESAP Architecture & Implementation**
|
|
|
|
|
|
* [ESAP-architecture](https://git.astron.nl/astron-sdc/escape-wp5/esap-api-gateway/-/wikis/ESAP-architecture)
|
|
|
* [ESAP API Gateway](https://git.astron.nl/astron-sdc/escape-wp5/esap-api-gateway/-/wikis/esap-api-gateway)
|
|
|
|
|
|
**How to Build & Deploy ESAP**
|
|
|
|
|
|
* [Development & test mode](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Build-&-Deploy-ESAP/Development-mode-(localhost))
|
|
|
* Containers deployment: [localhost](http://localhost) and [server](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Build-&-Deploy-ESAP/Production-mode-(server))
|
|
|
|
|
|
**ESAP Configuration**
|
|
|
|
|
|
* [ESAP API Gateway fook&feel configuration](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/ESAP-configuration)
|
|
|
* [ESAP API Gateway databases](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/ESAP-databases)
|
|
|
* [Authentication and authorization](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/OIDC,%20IAM%20and%20federated%20AAI)
|
|
|
* [ESAP Shopping basket](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/ESAP-Shopping-Basket)
|
|
|
|
|
|
**ESAP Services categories**
|
|
|
|
|
|
* [Service Category - Interactive](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Service-Category---Interactive-Analyses)
|
|
|
* [Service category - Query](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Service-Category-Query)
|
|
|
* [Service category - Rucio](/astron-sdc/escape-wp5/esap-api-gateway/-/wikis/Service%20Category%20-%20Rucio)
|
|
|
* [Service category - Batch](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Service-Category-Batch)
|
|
|
|
|
|
**ESAP at ASTRON**
|
|
|
|
|
|
* [ESAP-GUI](https://sdc-dev.astron.nl/esap-gui/)
|
|
|
* [ESAP API Gateway Query](https://sdc-dev.astron.nl/esap-api/query/)
|
|
|
* [Administration site](https://sdc-dev.astron.nl/esap-api/admin/)
|
|
|
|
|
|
**Tutorials and How-tos**
|
|
|
|
|
|
* [Add a new facility - BinderHub](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Add-a-new-facility---BinderHub)
|
|
|
* [Add a new notebook](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/Add-a-new-Jupyter-notebook-to-ESAP)
|
|
|
* [Add a new archive](https://git.astron.nl/astron-sdc/escape-wp5/esap-api-gateway/-/wikis/Add-a-new-archive-to-ESAP)
|
|
|
|
|
|
**WIP**
|
|
|
|
|
|
* [Async ESAP](https://git.astron.nl/astron-sdc/esap-api-gateway/-/wikis/WIP/Asynchronous-ESAP) |
|
|
\ No newline at end of file |