.. deSEAsion documentation master file, created by
   sphinx-quickstart on Wed Jun 20 10:01:50 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=======================
deSEAsion documentation
=======================

.. toctree::
   :maxdepth: 2
   :caption: Contents
   :hidden:

   installation
   deployment-cases
   user_guides
   api
   use_cases
   development
   python_api
   proposed_changes


Getting started
===============

Installation
------------

.. role:: bash(code)
    :language: bash

This web application is packaged using docker compose.
All the following instruction consider you have a working docker/docker compose
installation on your system.
If you need any help setting up docker, please visit the
`docker doc <https://docs.docker.com/engine/install/>`_.

That's it! This repository contains an example `docker-compose.yml` file which you can modify
according to your need:

.. literalinclude:: docker-compose.yml
   :language: yaml

This file needs environment variables, they can be supplied by a `.env` file present in the same directory.
Here is a working example:

.. literalinclude:: .example.env
   :language: bash

Alternatively, you can build the required docker images to run deSEAsion:

.. code:: bash

   git clone https://gitlab.com/decide.imt-atlantique/deseasion.git
   cd deseasion
   make docker

You can also replace the `git clone` command by downloading the source code archive from one of our release: `Deseasion Releases <https://gitlab.com/decide.imt-atlantique/deseasion/-/releases>`_

Any information regarding the application configuration can be found in
:doc:`installation section <installation>`.

Starting the application
------------------------

To start in daemon mode (better for production):

.. code:: bash

    docker compose up -d

To start in the terminal (will be shut down once the terminal is stopped):

.. code:: bash

    docker compose up

That's it! You only need to wait around a minute for the whole application to start.

Using the application
---------------------

Add users
~~~~~~~~~

.. code:: bash

    docker compose exec -it backend flask user create

Using the application
~~~~~~~~~~~~~~~~~~~~~

Go to your browser and get the `application page <http://localhost>`_.

Check the backend API
~~~~~~~~~~~~~~~~~~~~~

Go to your browser and get the `Swagger-UI <http://localhost/api/apidocs>`_.

Copyright and licence
=====================

deSEAsion is copyrighted (C) 2016-2025 by IMT Atlantique Bretagne Pays de la Loire
and Service hydrographique et océanographique de la marine (Shom).
Licensed under the European Union Public Licence (EUPL) v1.2.

Please refer to the file LICENCE containing the text of the EUPL v1.2.

You may also obtain a copy of the license at:
https://joinup.ec.europa.eu/software/page/eupl

For more information on this license, please refer to:

  - European Union Public Licence:
    https://joinup.ec.europa.eu/collection/eupl/eupl-guidelines-faq-infographics


Distribution
============

This project is distributed in multiple ways:

- as source code: in which case the above copyright notice is applied
- as a python package `deseasion-backend <https://pypi.org/project/deseasion-backend/>`_: in which case the above copyright notice is applied
- as docker images (see `container registry <https://gitlab.com/decide.imt-atlantique/deseasion/container_registry>`_): in each published docker images, licenses (including third-party) and copyright notices are gathered inside the container in the /licenses folder


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`