X-Git-Url: https://bilbo.iut-bm.univ-fcomte.fr/and/gitweb/predictops.git/blobdiff_plain/112f16f03b1557eac45b06b9b0bd7e3e9c9579f4..ef7617a10d088cccaa6acd8b45a0db76bd8fb61e:/README.md?ds=inline

diff --git a/README.md b/README.md
index b4cbde9..e2030e7 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,73 @@
-Creer un environnement :
-pip install virtualenv
-virtualenv predictops
+Configuration
+=============
 
-activer l'environnement :
-source ~/.venvs/predictops/bin/activate
+Initialisation de l'environnement de travail
+--------------------------------------------
 
-installer un package :
-pip install celery
-pip freeze > requirements.txt
+- Creer un environnement :
 
-Lancer 
-celery -A test_celery worker --loglevel=info
-puis 
-python -m test_celery.run_tasks
+`pip install virtualenv`
 
+`python -m venv ~/.venvs/predictops`
 
-Pour nettoyer la bdd :
-engine = ExtomeEngine(clean = False) -> dans le main
--> Remplir le répertoire data à partir d'archive
-dans pgModeler : Faire export
+- activer l'environnement :
 
+`source ~/.venvs/predictops/bin/activate`
 
-$ psql extome
-\dt  -> describe table
-select * from "PARAMETER";
 
+Gestion des packages
+--------------------
 
+- Mettre à jour la liste des packages
+
+`pip install -r requirements.txt`
+
+- installer un package :
+
+`pip install celery`
+
+`pip freeze > requirements.txt`
+
+
+Configuration de l'apprentissage
+--------------------------------
+
+Tout se passe dans le répertoire features
+
+1. Modifier learn.cfg :
+  - définition de l'ensemble d'apprentissage
+  - famille de features à considérer (météofrance...)
+  - opérations de pré-traitement
+  - ...
+
+2. Détailler le traitement de chaque famille de feature dans le cfg associé
+(feature_ephemeris.cfg, feature_meteo.cfg, etc.), en accord avec les fichiers
+csv associés dans le répertoire features. Dans ces derniers, le type spécifie
+si la variable est numérique (1), qualitative (2), ou si elle peut être consi-
+dérée comme de l'un ou l'autre type (3), comme le jour dans l'année.
+
+
+
+Exécution
+=========
+
+Script principal
+----------------
+
+`make`
+
+ou
+
+`python main.py`
+
+
+Tâches planifiées
+-----------------
+
+- Lancer le scheduling (à compléter)
+
+`celery -A test_celery worker --loglevel=info`
+
+puis
+
+`python -m test_celery.run_tasks`