Source code for dragonfly_doe2.doe.run_period

from dataclasses import dataclass
from ladybug.analysisperiod import AnalysisPeriod


@dataclass
class RunPeriod:

    begin_month: int = 1
    begin_day: int = 1
    begin_year: int = 2021
    end_month: int = 12
    end_day: int = 31
    end_year: int = 2021

    @classmethod
    def from_analysis_period(cls, analysis_period: AnalysisPeriod = None):
        analysis_period = analysis_period or AnalysisPeriod()
        cls_ = cls()
        cls_.begin_month = analysis_period.st_month
        cls_.begin_day = analysis_period.st_day
        cls_.end_month = analysis_period.end_month
        cls_.end_day = analysis_period.end_month

        return cls_

    def to_inp(self) -> str:
        """Return run period as an inp string."""
        # standard holidays should be exposed.
        return '"Entire Year" = RUN-PERIOD-PD\n   ' \
            'BEGIN-MONTH     = 1\n' \
            '   BEGIN-DAY      = 1\n' \
            '   BEGIN-YEAR     = 2021\n' \
            '   END-MONTH      = 12\n' \
            '   END-DAY        = 31\n' \
            '   END-YEAR       = 2021\n' \
            '   ..\n\n' \
            '"Standard US Holidays" = HOLIDAYS\n   ' \
            'LIBRARY-ENTRY "US"\n   ..'

    def __repr__(self) -> str:
        return self.to_inp()