mfire 4.0.post2

Code for PROMETHEE project

MFire

---

Status (develop branch)

Qu'est-ce-que Prométhée ?

Prométhée est un projet visant à automatiser la production de bulletins météorologiques. Ce projet se matérialise par une chaîne de traitement complexe allant de la configuration de bulletin sur Métronome, le traitement des données et la production des composants de bulletin sur super-calculateur, la mise à disposition de ces composants dans un service d'accès (CDP), et enfin l'assemblage de bulletins sur Métronome.

Qu'est-ce-que MFire ?

MFire est la librairie Python créée dans le cadre du projet Prométhée permettant de produire des composants de bulletin météo. Même si cete librairie est développée dans l'idée d'être déployée et utilisée sur super-calculateur, elle est parfaitement utilisable sur toute machine disposant des dépendances requises.

Installation

L'installation se fait par le dépôt Python standard de Météo-France : le Nexus (documentation du Nexus)

pip install --index-url http://nexm01-sidev.meteo.fr/repository/pypi-releases-mfire/simple --trusted-host nexm01-sidev.meteo.fr mfire

Dépendances

Les dépendances sont les suivantes :

name: mfire-env
dependencies:
  - bandit=1.7.5
  - black=23.10.1
  - bottleneck=1.3.7
  - cfgrib=0.9.10.4
  - dask=2023.11.0
  - eccodes=2.28.0
  - flake8=6.1.0
  - geojson=3.1.0
  - geopandas=0.14.1
  - netcdf4=1.6.2
  - numpy=1.26.0
  - opencv=4.6.0
  - pandas=2.1.3
  - pillow=9.2.0
  - pint=0.22
  - pip=23.3.1
  - pydantic=2.6.3
  - pydantic-settings=2.2.1
  - pytest=7.4.3
  - pytest-cov=4.1.0
  - python=3.10.13
  - scikit-image=0.22.0
  - scikit-learn=1.3.2
  - scipy=1.11.3
  - shapely=2.0.1
  - tensorflow=2.11.0
  - xarray=2023.11.0
  - dtaidistance=2.3.11
  - pip:
    - mflog==0.1.0
    - centerline==0.6.3
    - geojsoncontour==0.4.0
    - opencv-python==4.5.5
    - opencv-python-headless==4.6.0.66

Note : Il est recommandé d'installer ces dépendances dans un environnement conda en utilisant ce fichier environment.yml et grâce à la commande conda env create -f environment.yml.

Installation en développement

Pour une utilisation en développement, il vous faut :

1. une installation de conda (Miniconda par exemple) ;
2. la commande make ;
3. cloner ce dépôt git ;
4. une fois dans le dossier mfire, exécuter :

make install

Voir la documentation complète d'installation en développement

Documentation

Voir la documentation d'utilisation

Contribuer à MFire

Voir le guide de contribution

Licence

Licence

---