.. Seapopym documentation master file, created by
   sphinx-quickstart on Tue Mar 12 10:38:13 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Seapopym
========

Description
-----------

Seapodym is a Python package that provides models to simulate the dynamics of low and mid trophic level marine ecosystems. It is designed to be used in the context of the Spatial Ecosystem And POpulation DYnamics Model (`SEAPODYM`_) project.

.. _SEAPODYM: http://www.seapodym.eu/

This package was developed by Jules Lehodey as part of his thesis *"Data driven modeling approach of mesozooplankton and micronekton functional groups"*.

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

This package use the `Poetry`_ package manager. To install the package, you can run the following command:

.. _Poetry: https://python-poetry.org/

```bash
pip install seapopym
```

PyPi package is available `here`_.

.. _here: https://pypi.org/project/seapopym/

Or you can download the source code and run the following command:

```bash
poetry install
```


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   
   examples
   modules