Merge branch 'master' of https://gitlab.irap.omp.eu/epallier/pyros

Etienne Pallier
2 parents 0393f729 4778e01f
Showing 9 changed files with 103 additions and 21 deletions Show diff stats
.pydevproject
install/install_requirements.sh
src/analyzer/tasks.py
src/common/Device.py
src/majordome/tasks.py
src/monitoring/tasks.py
src/observation_manager/tasks.py
src/routine_manager/RequestSerializer.py
src/scheduler/tasks.py
@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<?eclipse-pydev version="1.0"?><pydev_project>
-<pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">pyros_venv_py3</pydev_property>
-<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 3.0</pydev_property>
-<pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
-<path>/${PROJECT_DIR_NAME}/src</path>
-</pydev_pathproperty>
-<pydev_variables_property name="org.python.pydev.PROJECT_VARIABLE_SUBSTITUTION">
-<key>DJANGO_MANAGE_LOCATION</key>
-<value>src/manage.py</value>
-<key>DJANGO_SETTINGS_MODULE</key>
-<value>pyros.settings</value>
-</pydev_variables_property>
-</pydev_project>
@@ -17,7 +17,7 @@ PORT=8000
 # String variables
-ASK_USE_MYSQL="-Do you wish to use mysql in your project ? Only if mysql-server is installed. (Y/N)"
+ASK_USE_MYSQL="-Do you wish to use mysql in your project ? Only if mysql-server is installed. (Default: No) (Y/N)"
 ASK_MYSQL_USERNAME="-MySQL server login (default $USERNAME): "
 SQL_SCRIPT="CREATE DATABASE IF NOT EXISTS pyros; GRANT USAGE ON *.* TO '$DB_USER'; DROP USER '$DB_USER'; GRANT ALL ON pyros.* TO '$DB_USER'@'localhost' IDENTIFIED BY '$DB_PASSWORD'; GRANT ALL ON test_pyros.* TO '$DB_USER'@'localhost'"
 SQL_FAIL="-Failed to execute database script, probably due to a wrong username or password"
@@ -9,12 +9,17 @@ import os
 import observation_manager
 class analysis(Task):
+    '''
+        Gets the name of the image to analyze in parameter
+        It applies the calibrations, then makes the 
+    '''
     def run(self, image_name):
         # je dois jsute créer mes deux fonctions, une pour les corrections, et l'autre pour les analyses
         print("analysis : ", image_name)
         new_img = self.apply_calibrations(image_name)
+        # TODO: Faire ça uniquement si c'est une image provenant d'une alerte
         self.do_analysis(new_img)
         # TODO: virer tout ça
@@ -25,12 +30,20 @@ class analysis(Task):
         Log.objects.create(agent='Analyzer', message=message)
     def apply_calibrations(self, image_name):
+        '''
+            Uses the calibration files to correct the image (changes the image bytes)
+            Send the new images to the FSC
+        '''
         # TODO: récupérer les bonne images dans le dossier analyzer/calibrations, et les appliquer
         # renvoie le nom de l'image calibrée; penser à vérifier que les fichiers de calibration existent à cet endroit
         # TODO: copier l'image dans le bon dossier pour le filesync (lien symbolique)
         return "toto.fitz"
     def do_analysis(self, new_img):
+        '''
+            Use the scientific softwares to create analysis files (doesn't change the image bytes)
+            Sends the results to the FSC
+        '''
         # TODO: utiliser les programmes scientifiques pour générer les analyses
         # TODO: copier les résultats des analyses dans le bon dossier pour le filesync (lien symbolique)
         pass
 \ No newline at end of file
@@ -2,13 +2,23 @@ from pyrosapp.models import *
 class DeviceObj():
+    '''
+        Generic object for the communication with all the devices (need inheritance)
+    '''
+
     def __init__(self):
+        '''
+            The messages and their parameters will be defined in the objects that inherits from this class
+        '''
         set_msgs = []
         get_msgs = []
         do_msgs = []
     def set(self, cmd, *args):
+        '''
+            Send a SET message to the device
+        '''
         msg = [msg for msg in self.set_msgs if msg[0] == cmd]
         if len(msg) == 0:
             raise ValueError("Invalid message argument %s" % (cmd,))
@@ -24,6 +34,9 @@ class DeviceObj():
     def get(self, cmd):
+        '''
+            Send a GET message to the device
+        '''
         if cmd not in self.get_msgs:
             raise ValueError("Invalid message argument %s" % (cmd,))
@@ -31,6 +44,9 @@ class DeviceObj():
     def do(self, cmd, *args):
+        '''
+            Send a DO message to the device
+        '''
         msg = [msg for msg in self.do_msgs if msg[0] == cmd]
         if len(msg) == 0:
             raise ValueError("Invalid message argument %s" % (cmd,))
@@ -11,8 +11,18 @@ from DateTime import DateTime
 import scheduler
 DAILY_SECOND = 1 / 86400
+MAX_WAIT = 180
 class execute_sequence(Task):
+    '''
+        Task to handle the execution of ONE sequence
+        It receives the shs' id in parameter.
+        It prepairs the instruments and cut the sequence in plan. Then the execute_plan tasks are created.
+        
+        If possible, it advances the sequence start.
+        If the sequence can't start within MAX_WAIT seconds, it relaunches a scheduling
+    '''
+
     def run(self, shs_pk):
         # on ne supprime JAMAIS un séquence en cours, donc je peux la virer des tasks dès le début
@@ -33,7 +43,7 @@ class execute_sequence(Task):
         countdown = self.get_countdown(shs, sequence)
-        if countdown > 180 * DAILY_SECOND:
+        if countdown > MAX_WAIT * DAILY_SECOND:
             scheduler.tasks.scheduling.delay(first_schedule=True, alert=False)  # TODO : changer le first_schedule à False
             return
@@ -116,6 +126,10 @@ class execute_sequence(Task):
         return countdown
 class system_pause(Task):
+    '''
+        Task called by the monitoring in case of problem.
+        It stops the system and the instruments.
+    '''
     def run(self):
         time.sleep(5)
@@ -123,14 +137,22 @@ class system_pause(Task):
 class system_restart(Task):
-
+    '''
+        Task called by the monitoring when there is no more problem.
+        Should just make a scheduling.
+    '''
     def run(self):
         time.sleep(5)
         print("system_restart")
 class change_obs_conditions(Task):
-
+    '''
+        Task called by the monitoring when the obs condition have changed.
+        It reads them in the DB and changes the sequences status in consequence.
+        If needed, relaunches a scheduling
+    '''
     def run(self):
+        # important : penser à rendre les quotas aux users
         time.sleep(5)
         print("change_obs_conditions")
@@ -16,6 +16,16 @@ import time
 TIMER_CHECK = 10  # in seconds
 class monitoring(Task):
+    '''
+        Infinite task created at the program's start.
+        It initilize all the external connections, and starts the alert_listener.
+        
+        This is the place to put the starting configurations.
+        
+        Once the starting configurations are done, it becomes a loop that checks the PLC and instruments status.
+        It also handles the beginning and the end of the night, recalculating them at each end of night.
+    '''
+
     def run(self):
         self.configure_instruments()
@@ -34,6 +44,9 @@ class monitoring(Task):
         self.timers_loop()
     def configure_instruments(self):
+        '''
+            Creates the communication objects for each instrument, and give them the basic configurations.
+        '''
         self.tel = TelescopeObj()
         self.vis_camera = VISCameraObj()
         self.nir_camera = NIRCameraObj()
@@ -49,10 +62,16 @@ class monitoring(Task):
         # Cette fonction dépendra du moyen de partager les connections des instruments
     def connect_to_plc(self):
+        '''
+            Initialize the connection to the PLC
+        '''
         # TODO: initialiser la co avec le plc et stocker les identifiants de la co dans self
         pass
     def update_software_versions(self):
+        '''
+            Reads the softwares versions in the settings.py, store them in the DB and send them to the IC.
+        '''
         versions = settings.MODULES_VERSIONS
         for module, version in versions.items():
@@ -65,12 +84,18 @@ class monitoring(Task):
         # TODO: envoyer les versions à l'IC
     def get_night_start_end(self):
+        '''
+            Computes the beginning and the end of the following (or current) night
+        '''
         # TODO: utiliser un logiciel by AK pour stocker en local le début et la fin de la nuit (on est peut-être dedans)
         self.night_start = time.time() + 180 / 86400
         self.night_end = time.time() + 360 / 86400
         pass
     def wait_devices_ready(self):
+        '''
+            Loop to wait for the device to be idle avec the starting configurations.
+        '''
         # TODO: faire une boucle pour attendre que les devices soient prêts
         pass
@@ -14,6 +14,10 @@ import os
 IMAGES_FOLDER = 'simulation_images'
 class execute_plan_vis(Task):
+    '''
+        Gives the orders to the instruments to retrieve the image(s) of a plan VIS.
+        Send hte images to the analyzer
+    '''
     def run(self, plan_id, countdown):
 #         print("ex plan : ", self.request.id)
@@ -48,6 +52,9 @@ class execute_plan_vis(Task):
         Log.objects.create(agent='Observation manager', message=message)
     def set_camera(self, cam, plan):
+        '''
+            Set the camera configuration
+        '''
         cam.filter_wheel.set("FILTER", FilterW.FilterEnum.h)
         cam.filter_wheel.do("CHANGE_FILTER")
@@ -62,7 +69,9 @@ class execute_plan_vis(Task):
         cam.set("BINNING", 300, 300)
     def wait_camera_ready(self, cam):
-
+        '''
+            Loop to wait for the configuration to be done
+        '''
         st = 0
         while st == 0:
             # TODO: uncomment quand on caura la télescope en global
@@ -77,7 +86,9 @@ class execute_plan_vis(Task):
     def wait_camera_finished(self, cam):
-
+        '''
+            Loop to wait for the observation to be finished
+        '''
 #         countdown = cam.get("TIMER")
 #         while countdown > 5:
 #             time.sleep(5)
@@ -96,6 +107,10 @@ class execute_plan_vis(Task):
 class execute_plan_nir(Task):
+    '''
+        Gives the orders to the instruments to retrieve the image(s) of a plan NIR.
+        Send the images to the analyzer
+    '''
     def run(self, plan_id, countdown):
 #         print("ex plan : ", self.request.id)
@@ -181,4 +196,4 @@ class execute_calibrations(Task):
          When they are all finished, it creates the 'super' calibration files.
      '''
      def run(self):
-         pass
 \ No newline at end of file
+         pass
@@ -84,6 +84,10 @@ class RequestSerializer():
         return ""
     def unserialize_request(self, request):
+        '''
+            Receives an xml.etree request and unserialize it 
+        '''
+
         if request.tag != "request":
             return "Main object should be a request (found %s instead)" % (request.tag,)
         possible_attribs = ["name", "scientific_program", "target_type"]
@@ -35,6 +35,7 @@ class scheduling(Task):
             TaskId.objects.create(task_id=res.id, task="execute_sequence")
     def determine_schedule_limits(self):
+        # TODO: virer ce système là pour la production
         sequences = Sequence.objects.all()
         ''' Find the most recurrent night in all sequences '''
         days = {}