models.py 21.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
from django.db import models
from pyrosapp.models import Schedule, Sequence
from operator import attrgetter
from decimal import *

DEFAULT_PLAN_START = 2457485.250000 # April 6th 2016, 18:00:00.0 UT
DEFAULT_PLAN_END = 2457485.916667 # April 7th 2016, 10:00:00.0 UT

class Interval:
    """
    Simple class that represents an interval of time
    Julian days should be used
    """
    
    def __init__(self, start, end):
        self._start = Decimal(start)
        self._end = Decimal(end)
        self.duration = Decimal(end - start)

        
    def __str__(self):
        print("["+str(self.start)+" - "+str(self.end)+"]")

    def _get_start(self):
        return self._start

    def _set_start(self, start):
        if start > self._end:
            raise ValueError("Cannot set start (%d): must be lower than end (%d)" % (start, self._end))
        self._start = start
        self.duration = self._end - self._start
        
    def _get_end(self):
        return self._end

    def _set_end(self, end):
        if end < self._start:
            raise ValueError("Cannot set end (%d): must be bigger than start (%d)" % (end, self._start))
        self._end = end
        self.duration = self._end - self._start
        
    start = property(fget=_get_start, fset=_set_start)
    end = property(fget=_get_end, fset=_set_end)

class Scheduler():
    """
   Role : create a planning for the following/current night
   
   Read in DB : Sequence, PyrosUser, ScheduleHistory and parents
   Create in DB : Schedule, ScheduleHistory ? (not sure)
   Update in DB : Schedule, Sequence
   Delete in DB : None
   
   Entry point(s) :
           - make_schedule
    """

    """
    TODO:
        - voir TODOs dans les commentaires
        - fonction de scheduling ( et descendance)
        - gestion du re-scheduling (en cas de nouvelle requete)
        - tests
        - remplissage des espaces libres
        - gestion de l'historique (je sais pas si c'est ce module qui va s'en charger au final mais bon ...)

    """

    def __init__(self):
        self.schedule = Schedule.objects.create()
        # TODO: quel est le "flag" dans le schedule ??
        # il faudrait peut-être appeler ces deux fonctions dans la méthode make_schedule ... ou recevoir plan_start et plan_end en param
        self.get_night_limits() # TODO
        self.intervals = []
    
        
    def get_night_limits(self):
        '''
        determines and set plan_start and plan_end (beginning & end of the observation night)        
        '''
        
        # TODO: définir comment on calcule plan_start et plan_end (via quels moyens)
        self.schedule.plan_start = DEFAULT_PLAN_START # default value
        self.schedule.plan_end = DEFAULT_PLAN_END # default value
        
    
    def make_schedule(self):
        '''
        ENTRY POINT

        Check all 'OBSERVABLE' sequences to create the most optimized planning for the following/current night
        
        It is assumed that all sequences that MUST and CAN be analyse have the OBSERVABLE status (e.g. : there must not be any PLANNED sequence at this point)        
        
        :side-effect :
            - modify sequences status and dates in DB
        '''
        
        self.intervals.append(Interval(self.schedule.plan_start, self.schedule.plan_end))
        self.sequences = list(Sequence.objects.filter(status=Sequence.OBSERVABLE))
        self.check_sequences_validity()
        self.determine_priorities()
        self.remove_not_eligible_sequences()
        self.sort_by_jd2_and_priorities()
        self.organize_sequences()
        self.save_sequences()


    def check_sequences_validity(self):
        '''
        Checks come sequence attributes to validate their integrity
        
        :side-effect :
            - remove invalid sequences from self.sequences
            - set INVALID status for invalid sequences in DB
        '''
        
        ''' Note(1) '''
        for sequence in list(self.sequences):
            if sequence.jd1 < 0 or sequence.jd2 < 0 or sequence.duration <= 0 or sequence.jd2 - sequence.jd1 < sequence.duration:
                self.sequences.remove(sequence)
                sequence.status = Sequence.INVALID
                sequence.save()
            
            
    def determine_priorities(self):
        '''
        Computes sequences priority according to the user, the scientific program, ...        
        '''
        
        # TODO: définir comment on calcule la priorité
        pass
    
    
    def remove_not_eligible_sequences(self):
        '''
        Computes overlap between [jd1; jd2] and [plan_start; plan_end]
        Removes from self.sequences all the sequences that cannot be observed between plan_start and plan_end
        Set UNPLANNABLE sequences if jd2 < plan_start
        
        :side-effect :
            - remove unwanted sequences from self.sequences
        '''
        
        ''' Note (1) '''        
        for sequence in list(self.sequences):
            overlap = min(self.schedule.plan_end, sequence.jd2) - max(self.schedule.plan_start, sequence.jd1)
            if overlap < sequence.duration:
                if sequence.jd1 < self.schedule.plan_start:
                    """ Note (2) """
                    sequence.status = Sequence.UNPLANNABLE
                    sequence.save()
                self.sequences.remove(sequence)

        
    def sort_by_jd2_and_priorities(self):
        '''
        Sort by priority and jd2, priority being the main sorting parameter        
        '''
        
        self.sequences.sort(key=attrgetter('priority', 'jd2'))
        

    def organize_sequences(self):
        '''
        Main function of the Scheduler
        Arrange a maximum of observable sequences in the planning

        Algorithm (for each sequence) :
            - check quota (remove sequence from list if quota is too low)
            - select matching intervals
            - IF matching intervals => place sequence according to tPrefered
            - IF NO matching intervals => try to move other sequences to place this one
        
        :side-effect :
            - remove unwanted sequences from self.sequences
            - change status and dates of sequences in self.sequences (but not in DB yet)
        '''
   
        ''' Note (1) '''     
        for sequence in list(self.sequences):
            quota = self.determine_quota(sequence)
            if quota < sequence.duration:
                self.sequences.remove(sequence)
                continue

            matching_intervals = self.get_matching_intervals(sequence)
            if len(matching_intervals) > 0:
                self.place_sequence(sequence, matching_intervals)
                sequence_placed = True
            else:
                sequence_placed = self.try_shifting_sequences(sequence)
                
            if sequence_placed == True:
                sequence.status = Sequence.PLANNED
                self.update_quota(sequence)
    
    def determine_quota(self, sequence:Sequence) -> float:
        '''
        Determines the quota (in minutes) according to the current planning duration and the quota of the user and scientific program associated

        :returns : The quota (float)
        '''
        # TODO: définir comment on calcule le quota
        
        return sequence.request.pyros_user.quota # default value
        
    
    def get_matching_intervals(self, sequence:Sequence):
        '''
        Find the intervals where the sequence could be inserted
        
        :returns : list of matching Intervals
        '''
        
        matching_intervals = []
        
        for interval in self.intervals:
            overlap = min(sequence.jd2, interval.end) - max(sequence.jd1, interval.start)
            if overlap >= sequence.duration:
                matching_intervals.append(interval)
        
        return matching_intervals
        
        
    def place_sequence(self, sequence:Sequence, matching_intervals) :
        '''
        Place the sequence in the better interval, according to the t_prefered
        
        :type matching_intervals: list [Interval]
        :param matching_intervals: Intervals in which the sequence can be placed

        :side-effect :
            - changes self.intervals
            - change the sequence if it it placed
        '''
        
        if len(matching_intervals) == 0:
            raise ValueError("matching_intervals shall not be empty")

        prefered_interval = self.get_prefered_interval(sequence, matching_intervals)
        sequence_position_in_interval = self.get_sequence_position_in_interval(sequence, prefered_interval)        
        self.insert_sequence_in_interval(sequence, prefered_interval, sequence_position_in_interval)
        self.cut_interval(sequence, prefered_interval)
        self.update_other_deltas(sequence, prefered_interval)

            
    def get_prefered_interval(self, sequence:Sequence, matching_intervals) -> Interval:
        '''
        Find the better interval, according to the t_prefered (get the nearest)
        
        :type matching_intervals: list [Interval]
        :param matching_intervals: Intervals in which the sequence can be placed
        
        :returns : An Interval that fits sequence.t_prefered at most
        '''

        if len(matching_intervals) == 0:
            raise ValueError("matching_intervals shall not be empty")

        if sequence.t_prefered == 0 or len(matching_intervals) == 1:
            prefered_interval = matching_intervals[0]
        else:
            for index, interval in enumerate(matching_intervals):
                if interval.start <= sequence.t_prefered <= interval.end:
                    prefered_interval = interval
                    break
                elif sequence.t_prefered < interval.start:
                    if index == 0:
                        prefered_interval = interval
                    else:
                        prefered_interval = matching_intervals[index - 1]
                    break
        return prefered_interval
        
    
    def get_sequence_position_in_interval(self, sequence:Sequence, interval:Interval) -> str:
        '''
        Determines where the sequence will be inserted in the interval, regarding sequence.t_prefered

        :returns : A string in ["START", "END", "PREFERED"] describing where the sequence will be inserted in the interval
        '''

        if interval.start <= sequence.t_prefered <= interval.end:
            if (sequence.t_prefered - Decimal(0.5) * sequence.duration) <= interval.start:
                position_in_interval = "START"
            elif (sequence.t_prefered + Decimal(0.5) * sequence.duration) >= interval.end:
                position_in_interval = "END"
            else:
                position_in_interval = "PREFERED"  
        else:
            if sequence.t_prefered < interval.start:
                position_in_interval = "START"
            else:
                position_in_interval = "END"
        return position_in_interval
    

    def insert_sequence_in_interval(self, sequence:Sequence, interval:Interval, position:str):
        '''
        Inserts the sequence in the interval:
            - sets sequence.tsp and sequence.tep
            - sets sequence.deltaTL and sequence.deltaTR
            
        :param interval: Interval in which the sequence will be inserted
        :param position: String describing where the sequence will be inserted in the interval
        
        :side-effect :
            - modify sequence attributes (tsp, tep, deltaTL, deltaTR)
        '''
        
        if position not in ["START", "END", "PREFERED"]:
            raise ValueError("position must be either 'START', 'END' or 'PREFERED'")
        
        if position == "START":
            sequence.tsp = max(interval.start, sequence.jd1)
            sequence.tep = sequence.tsp + sequence.duration
            sequence.deltaTL = 0
            sequence.deltaTR = min(interval.end, sequence.jd2) - sequence.tep
        elif position == "END":
            sequence.tep = min(interval.end, sequence.jd2)
            sequence.tsp = sequence.tep - sequence.duration
            sequence.deltaTL = sequence.tsp - max(interval.start, sequence.jd1)
            sequence.deltaTR = 0
        else:
            sequence.tsp = max(sequence.jd1, sequence.t_prefered - Decimal(0.5) * sequence.duration)
            sequence.tep = sequence.tsp + sequence.duration
            sequence.deltaTL = sequence.tsp - max(interval.start, sequence.jd1)
            sequence.deltaTR = min(interval.end, sequence.jd2) - sequence.tep

        
    def cut_interval(self, sequence:Sequence, interval:Interval):
        '''
        Separates the interval in two parts regarding to the sequence position
        Sorts the interval list in time order
        
        :param interval : the interval in which the sequence was added
        
        :side-effect :
            - removes interval from self.intervals
            - add created intervals to self.intervals
            - sorts self.intervals
        '''
        
        interval_before_sequence = Interval(interval.start, sequence.tsp)
        interval_after_sequence = Interval(sequence.tep, interval.end)
        
        self.intervals.remove(interval)
        if interval_before_sequence.duration > 0:
            self.intervals.append(interval_before_sequence)
        if interval_after_sequence.duration > 0:
            self.intervals.append(interval_after_sequence)
        self.intervals.sort(key=lambda interval: interval.start, reverse=False)


    def update_other_deltas(self, sequence:Sequence, interval:Interval):
        '''
        Update deltaTL and deltaTR of sequences planned near this sequence
        
        :param interval: Interval in which the sequence was added
        
        :side-effect :
            - modify deltaTL and deltaTR of sequences before and after the interval
        '''
        
        for sequence_ in self.sequences:
            if sequence_.status == Sequence.PLANNED:
                if sequence_.tep == interval.start:
                    sequence_before_interval = sequence_
                elif sequence_.tsp == interval.end:
                    sequence_after_interval = sequence_
        
        if 'sequence_before_interval' in locals():
            sequence_before_interval.deltaTR = min(sequence.tsp, sequence_before_interval.jd2) - sequence_before_interval.tep                    
        if 'sequence_after_interval' in locals():
            sequence_after_interval.deltaTL = sequence_after_interval.tsp - max(sequence.tep, sequence_after_interval.jd1)
        
    
    def try_shifting_sequences(self, sequence:Sequence) -> bool:
        '''
        Tries to find a place in the planning for the sequence, moving the other sequences
        
        :returns : A boolean -> True if the sequence was placed, False otherwise
        
        :side-effect:
            - might change some sequences' deltaTL and/or deltaTR
        '''
        
        potential_intervals = self.get_potential_intervals(sequence)
        potential_intervals.sort(key=attrgetter("duration"), reverse=True)
        for interval in potential_intervals:
            ''' we get the adjacent sequences '''
            for sequence_ in self.sequences:
                if sequence_.status == Sequence.PLANNED:
                    if sequence_.tep == interval.start:
                        sequence_before_interval = sequence_
                    elif sequence_.tsp == interval.end:
                        sequence_after_interval = sequence_

            available_duration = min(interval.end, sequence.jd2) - max(interval.start, sequence.jd1)
            missing_duration = sequence.duration - available_duration
            
            if 'sequence_before_interval' in locals():
                possible_move_to_left = min(sequence_before_interval.deltaTL, interval.start - sequence.jd1)
            else:
                possible_move_to_left = 0
                
            if 'sequence_after_interval' in locals():
                possible_move_to_right =  min(sequence_after_interval.deltaTR, sequence.jd2 - interval.end)
            else:
                possible_move_to_right = 0

            if possible_move_to_left >= missing_duration:
                self.move_sequence(sequence_before_interval, missing_duration, "LEFT")
            elif possible_move_to_right >= missing_duration:
                self.move_sequence(sequence_after_interval, missing_duration, "RIGHT")
            elif possible_move_to_left + possible_move_to_right >= missing_duration:
                self.move_sequence(sequence_before_interval, possible_move_to_left, "LEFT")
                self.move_sequence(sequence_after_interval, missing_duration - possible_move_to_left, "RIGHT")
            else:
                continue

            matching_intervals = self.get_matching_intervals(sequence)
            if len(matching_intervals) != 1:
                raise ValueError("There should be one and only one matching interval after shifting")
            self.place_sequence(sequence, matching_intervals)

            return True
            
        return False
        
        
    def get_potential_intervals(self, sequence:Sequence):
        '''
        Find the intervals where a part of the sequence could be inserted
        
        :returns : list of partially-matching Intervals
        '''
        
        potential_intervals = []
        
        for interval in self.intervals:
            overlap = min(sequence.jd2, interval.end) - max(sequence.jd1, interval.start)
            if overlap > 0:
                potential_intervals.append(interval)
        
        return potential_intervals

        
    def move_sequence(self, sequence:Sequence, time_shift:float, direction:str):
        '''
        Moves the sequence in the wanted direction, decreasing its deltaTL or deltaTR.
        
        :param sequence: sequence to be moved
        :param time_shift: amplitude of the shift
        :param direction: "LEFT" or "RIGHT"
        
        :side-effect :
            - modify the sequence in self.sequences
            - changes the interval before and the interval after the sequence
        '''
        
        if direction not in ["LEFT", "RIGHT"]:
            raise ValueError("direction must be 'LEFT' or 'RIGHT'")
        if time_shift > (sequence.deltaTL if direction == "LEFT" else sequence.deltaTR):
            raise ValueError("Shift value is bigger than deltaT(R/L)")
        
        for interval in self.intervals:
            if interval.end == sequence.tsp:
                interval_before = interval
            elif interval.start == sequence.tep:
                interval_after = interval
                
        if direction == "LEFT":
            interval_before.end -= time_shift
            if "interval_after" in locals():
                interval_after.start -= time_shift
            sequence.tsp -= time_shift
            sequence.tep -= time_shift
            sequence.deltaTL -= time_shift
            sequence.deltaTR += time_shift
        else:
            if "interval_before" in locals():
                interval_before.end += time_shift
            interval_after.start += time_shift
            sequence.tsp += time_shift
            sequence.tep += time_shift
            sequence.deltaTL += time_shift
            sequence.deltaTR -= time_shift
        if "interval_before" in locals() and interval_before.duration == 0:
            self.intervals.remove(interval_before)
        if "interval_after" in locals() and interval_after.duration == 0:
            self.intervals.remove(interval_after)

        
    def update_quota(self, sequence:Sequence):
        '''
        Update the quota of the user / scientific program / whatever by substracting the sequence duration to the quotas
        
        :side-effect:
            - Modify User quota in DB
        '''
        
        # TODO: faire les vrais calculs de quota
        user = sequence.request.pyros_user
        user.quota -= float(sequence.duration) # action par défaut qui correspond au code de self.determine_quota
        user.save()
        
    def save_sequences(self):
        '''
        Final function : save in the db all modifications done to sequences, and the schedule
        
        :side-effect :
            - change sequences status and dates in DB
            - add a schedule in the DB
        '''
        
        for sequence in self.sequences:
            sequence.save()
        self.schedule.save()

    
    def print_schedule(self):
        '''
        ONLY FOR DEBUG
        
        Prints the planned sequences
        '''

        sequences = Sequence.objects.filter(status=Sequence.PLANNED).order_by('tsp')
        
        print("---- There are %d sequence(s) planned ----" % len(sequences))
        
        for sequence in sequences:
            print("name: %r\t, start: %d\t, end: %d\t, duration: %d\t, deltaTL: %d\t, deltaTR: %d\t"
                  % (sequence.name, sequence.tsp, sequence.tep, sequence.duration, sequence.deltaTL, sequence.deltaTR))

        print("---- There are %d free interval(s) ----" % len(self.intervals))
        
        for interval in self.intervals:
            print("start: %d\t, end: %d\t" % (interval.start, interval.end))

''' Notes

(1) list(self.sequences) creates a copy in order to modify self.sequences and still iterate on it without unexpected behavior
(2) UNPLANNABLE is a definitive status meaning that the sequence will never be able to be scheduled

'''