Metadata-Version: 2.1
Name: autosubmit-api
Version: 4.0.0b2
Summary: An extension to the Autosubmit package that serves its information as an API
Home-page: https://earth.bsc.es/gitlab/es/autosubmit_api
Author: Luiggi Tenorio, Bruno P. Kinoshita, Cristian Gutiérrez, Julian Berlin, Wilmer Uruchi
Author-email: support-autosubmit@bsc.es
License: GNU GPL
Keywords: autosubmit,API
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Flask ~=2.2.5
Requires-Dist: pyjwt ~=2.8.0
Requires-Dist: requests ~=2.28.1
Requires-Dist: flask-cors ~=3.0.10
Requires-Dist: bscearth.utils ~=0.5.2
Requires-Dist: pysqlite-binary
Requires-Dist: pydotplus ~=2.0.2
Requires-Dist: portalocker ~=2.6.0
Requires-Dist: networkx ~=2.6.3
Requires-Dist: scipy ~=1.7.3
Requires-Dist: paramiko ~=2.12.0
Requires-Dist: python-dotenv
Requires-Dist: autosubmitconfigparser ~=1.0.48
Requires-Dist: autosubmit >=3.13
Requires-Dist: Flask-APScheduler
Requires-Dist: gunicorn

# Autosubmit API

# Table of Contents

1. [Overview](#overview)
2. [Autosubmit Big Picture](#autosubmit-big-picture)
3. [General Knowledge Requirements](#general-knowledge-requirements)
4. [Installation](#Installation)

## 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

![Autosubmit Big Picture](/docs/Total_Autosubmit_Diagram.png)

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 the `historical 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` under `webadmin` 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](https://earth.bsc.es/gitlab/es/autosubmit_api). Currently, under **BSC** implementation, this API is running on `bscesweb04` under `webadmin` 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

```sh
pip install autosubmit-api # >=4.0 (recommended)

# Check installation
autosubmit_api start -h
```

Start the server:

```sh
autosubmit_api start
```
