.. _packaging-sec:

=========================
Linux packaging
=========================

This section explains how to prepare and compile a Debian package of `Code_TYMPAN` for a Debian bookwork
or an Ubuntu noble numbat distribution.

The files needed to generate a package are located in **`tympan_root_directory`/debian** directory.

Update files
====================

Unlike the Windows version, the linux package doesn't include Code_TYMPAN dependancies. 
Instead, when installing the package, the linux package manager search for dependancies in the "control" file.
Therefore, make sure to  update the "control" file with Code_TYMPAN dependancies (line "Depends") and version number (Line "Version").

Continuous Integration (CI)
=============================

The file ".gitlab-ci.yaml" must be updated :
	- To include all dependancies, which must be installed with "apt-get install"
	- The package name must be changed with the correct Code_TYMPAN version number and the correct Debian/Ubuntu version
	- Make sure to link the correct CGAL version
	- Make sure to link the correct version of Code_TYMPAN `3rd parties <https://code-tympan.readthedocs.io/en/latest/installing.html#lightweight-dependencies>`_.

	
All of these modifications must be included in both the "PackageBookworm" and "PackageUbuntu" jobs.

After the pipeline is completed, you can download the package in the "artifacts" archive.

Build package
=============

This section explains how to build the package locally if necessary, however, 
this is usually not necessary, as both the Ubuntu and Debian packages are generated by Gitlab CI.

This command must be run from the Code_TYMPAN root directory.

::

    cd debian
    ./build.sh

Install package
===============

::

    sudo apt-get update
    sudo apt install ./code-tympan_<version>_amd64.deb

The last command installs the missing dependencies listed in the package.

launch Code_tympan
==================

::

   Code_TYMPAN


uninstall debian package
========================

::

   sudo apt purge code-tympan


More information
================

For more information, read `Debian documentation`_.

.. _`Debian documentation`: https://www.debian.org/doc/manuals/maint-guide/

The user documentation is available at : https://sourceforge.net/projects/code-tympan/files/4.6.0/