ramp.UseCase.__init__

UseCase.__init__(name: str = '', users: Optional[List] = None, date_start: Optional[str] = None, date_end: Optional[str] = None, parallel_processing: bool = False, peak_enlarge: float = 0.15)

Creates a UseCase instance for gathering a list of User instances which own Appliance instances

Parameters:

  • name (str, optional) – name of the usecase instance, by default “”

  • users (Union[Iterable,None], optional) – a list of users to be added to the usecase instance, by default None

  • date_start (str, optional) – start date of the daily profiles generated by the UseCase instance

  • date_end (str, optional) – end date of the daily profiles generated by the UseCase instance

  • parallel_processing (bool, optional) – if set True, the profiles will be generated in parallel rather than sequencially

  • peak_enlarge (float, optional) – percentage random enlargement or reduction of peak time range length, used in UseCase.calc_peak_time_range