Skip to content

Latest commit

 

History

History
57 lines (42 loc) · 2.39 KB

README.md

File metadata and controls

57 lines (42 loc) · 2.39 KB
Raw

Python Badge

About

This repository is an educational purpose software, in collaboration with Cerema and the French Engineering School IMT Atlantique.

MaritIMT'Guard, rebranded on 2024 to look good on my portfolio, is a maritime surveillance software developed for identifying illegal fishing transhipments.

This software was an Engineering School Project, developped for Cerema, a public institution dedicated to supporting public policies.

How to Use

Python3 is required.

  1. Clone this repo

  2. Install requirements using:

    python3 -m pip install -r requirements.txt

  3. Set the configuration parameters on the config.json file:

    "GENERAL": [
    {
        "INPUT_PATH": "./inputs/ais_log/",
        "OUTPUT_PATH": "./outputs/",
        "OUTPUT_FILENAME": "",
        "DATABASE": "./inputs/ship_databases/ship_db_nano.xlsx",
        "TEXT_EDITOR": "C:/Program Files/Notepad++/notepad++.exe"
    }
]

  4. Run the software and interact with the basic cli:

    python3 main.py

    menu_screenshot

    1. Sortir du programme finishes the software
    2. Mettre a jour les types de bateaux updates the TYPE_BATEAUX section from config.json using the path from GENERAL["DATABASE"].
    3. Acceder au fichier de configuration prints the config.json file and opens your favorite text editor (set in GENERAL["TEXT_EDITOR"]).
    4. Chercher les possibles transbordements runs the main logic of the software and finds illegal transhipments from all the files (set in GENERAL["INPUT_PATH"]).

Appreciations

We would like to thank aayaffe and pirpyn for its work on pyAISm, a small python decoder for AIS messages.

We would like to thank the Cerema institution for having trust on us and for all the support.

Last but not least, we would like to thank the professor of the IMT Atlantique for all their support and for allowing this kind of cool high shool projects.