An extension to the Autosubmit package that serves its information as an API
Project description
Autosubmit API
Table of Contents
Overview
Autosubmit API is a package that consumes the information generated by Autosubmit and serves it as an API.
Distribution: https://pypi.org/project/autosubmit-api/
See the wiki for documentation.
Autosubmit Big Picture
In this image you can see the flow of information in the Autosubmit environment.
- Autosubmit: Machines running Autosubmit.
- Remote Platforms: Platforms (HPCs in most cases) to which Autosubmit connects to run jobs.
- Experiment Database: Starting from Autosubmit
3.13.0
, each experiment generates a set of databases that save important (reusable) information about it. We have thehistorical database
,graph database
,structures database
. - File System: The file system where the experiment files are stored.
- Data Process Workers: Autosubmit API implements a set of workers that periodically collect information from the experiments or complement that information. In the current BSC implementation, these workers are running no
bscesweb04
underwebadmin
user. - Main Database: Autosubmit API uses a centralized database to keep track of important experiment information. The workers fill this information. Autosubmit also writes into this database.
- Autosubmit API: See Autosubmit API. Currently, under BSC implementation, this API is running on
bscesweb04
underwebadmin
user. This API exposes a set of requests that Autosubmit GUI consumes and serves to the users through the front end. - Autosubmit GUI: This project.
- Authentication Server: BSC Central Authentication Service.
- Users: Users that access the GUI through their web browsers from any device. The current implementation requires that an user generates a token using the Authentication server once every 5 days.
General Knowledge Requirements
- Python 2.7
- Object Oriented Programming
- Flask
- Gunicorn
- Unit testing
Installation
Autosubmit API can be easily installed via pip
pip install autosubmit-api # >=4.0 (recommended)
# Check installation
autosubmit_api start -h
Start the server:
autosubmit_api start
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
autosubmit_api-4.0.0b2.tar.gz
(2.3 MB
view hashes)
Built Distribution
Close
Hashes for autosubmit_api-4.0.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dcdb883c63348be0a6925d2a749fe5f9fd184c37537ffd16781fc240d31e1a3d |
|
MD5 | 33d0edfafd762e3e6f20f60680b2d683 |
|
BLAKE2b-256 | 4e870c84e46f794c0db88fc4bc3ecf0727c7c14b7c069d4824aabc0b1d2a6002 |