Merge pull request #10 from peteryefi/dev

Dev

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.2
+current_version = 1.0.2b1
 commit = True
 tag = True
 

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 .coverage
-.bumpversion.cfg
+.bumpversion.cfg
+.DS_Store

MANIFEST.in

@@ -1,4 +1,8 @@
 include README.md
 include requirements.txt
+include LICENSE
 exclude tests/*
-exclude .github/*
+exclude .github/*
+exclude relationship/*
+exclude venv/*
+recursive-include metamenth *

readme.md → README.md

@@ -38,39 +38,39 @@ Read the documentation here: [MetamEnTh Documentation](https://github.com/petery
      ./run_tests.sh
 
 ### Example usage
+
 ```python
-from unittest import TestCase
-from misc import MeasureFactory
-from enumerations import RecordingType
-from datatypes.measure import Measure
-from enumerations import MeasurementUnit
-from structure.open_space import OpenSpace
-from enumerations import OpenSpaceType
-from enumerations import RoomType
-from structure.room import Room
-from structure.floor import Floor
-from enumerations import FloorType
-from structure.building import Building
-from enumerations import BuildingType
-from datatypes.address import Address
-from structure.layer import Layer
-from structure.material import Material
-from enumerations import MaterialType
-from enumerations import LayerRoughness
-from structure.cover import Cover
-from structure.envelope import Envelope
-from enumerations import CoverType
+from metamenth.misc import MeasureFactory
+from metamenth.enumerations import RecordingType
+from metamenth.datatypes.measure import Measure
+from metamenth.enumerations import MeasurementUnit
+from metamenth.structure.open_space import OpenSpace
+from metamenth.enumerations import OpenSpaceType
+from metamenth.enumerations import RoomType
+from metamenth.structure.room import Room
+from metamenth.structure.floor import Floor
+from metamenth.enumerations import FloorType
+from metamenth.structure.building import Building
+from metamenth.enumerations import BuildingType
+from metamenth.datatypes.address import Address
+from metamenth.structure.layer import Layer
+from metamenth.structure.material import Material
+from metamenth.enumerations import MaterialType
+from metamenth.enumerations import LayerRoughness
+from metamenth.structure.cover import Cover
+from metamenth.structure.envelope import Envelope
+from metamenth.enumerations import CoverType
 
 floor_area = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                        Measure(MeasurementUnit.SQUARE_METERS, 5))
+                                           Measure(MeasurementUnit.SQUARE_METERS, 5))
 # height of building
 height = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                    Measure(MeasurementUnit.METERS, 30))
+                                       Measure(MeasurementUnit.METERS, 30))
 # internal mass of the building
 internal_mass = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                           Measure(MeasurementUnit.KILOGRAMS, 2000))
+                                              Measure(MeasurementUnit.KILOGRAMS, 2000))
 area = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                           Measure(MeasurementUnit.SQUARE_METERS, 45))
+                                     Measure(MeasurementUnit.SQUARE_METERS, 45))
 # create room
 room = Room(area, "Office 1", RoomType.OFFICE)
 
@@ -87,26 +87,26 @@ address = Address("Montreal", "6399 Rue Sherbrooke", "QC", "H1N 2Z3", "Canada")
 
 # create building
 building = Building(2009, height, floor_area, internal_mass, address,
-                                 BuildingType.COMMERCIAL, [floor])
+                    BuildingType.COMMERCIAL, [floor])
 
 # material properties
 density_measure = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                        Measure(MeasurementUnit.KILOGRAM_PER_CUBIC_METER, 0.5))
+                                                Measure(MeasurementUnit.KILOGRAM_PER_CUBIC_METER, 0.5))
 hc_measure = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                        Measure(MeasurementUnit.JOULES_PER_KELVIN, 4.5))
+                                           Measure(MeasurementUnit.JOULES_PER_KELVIN, 4.5))
 tt_measure = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                   Measure(MeasurementUnit.WATTS_PER_SQUARE_METER_KELVIN, 2.5))
+                                           Measure(MeasurementUnit.WATTS_PER_SQUARE_METER_KELVIN, 2.5))
 tr_measure = MeasureFactory.create_measure(RecordingType.BINARY.value,
-                                                   Measure(MeasurementUnit.SQUARE_METERS_KELVIN_PER_WATTS,
-                                                          2.3))
+                                           Measure(MeasurementUnit.SQUARE_METERS_KELVIN_PER_WATTS,
+                                                   2.3))
 # create roof material
 roof_material = Material(
-    description="Steel roof",
-    material_type=MaterialType.ROOF_STEEL,
-    density=density_measure,
-    heat_capacity=hc_measure,
-    thermal_transmittance=tt_measure,
-    thermal_resistance=tr_measure
+   description="Steel roof",
+   material_type=MaterialType.ROOF_STEEL,
+   density=density_measure,
+   heat_capacity=hc_measure,
+   thermal_transmittance=tt_measure,
+   thermal_resistance=tr_measure
 )
 
 # roof layer measurement

datatypes/address.py → metamenth/datatypes/address.py

@@ -1,6 +1,6 @@
-from .point import Point
-from datatypes.binary_measure import BinaryMeasure
-from misc import Validate
+from metamenth.datatypes.point import Point
+from metamenth.datatypes.binary_measure import BinaryMeasure
+from metamenth.misc import Validate
 
 
 class Address:

datatypes/binary_measure.py → metamenth/datatypes/binary_measure.py

@@ -1,6 +1,6 @@
-from datatypes.interfaces.abstract_measure import AbstractMeasure
-from .measure import Measure
-from enumerations import DataMeasurementType
+from metamenth.datatypes.interfaces.abstract_measure import AbstractMeasure
+from metamenth.datatypes.measure import Measure
+from metamenth.enumerations import DataMeasurementType
 
 
 class BinaryMeasure(AbstractMeasure):

datatypes/continuous_measure.py → metamenth/datatypes/continuous_measure.py

@@ -1,5 +1,5 @@
-from datatypes.interfaces.abstract_range_measure import AbstractRangeMeasure
-from .measure import Measure
+from metamenth.datatypes.interfaces.abstract_range_measure import AbstractRangeMeasure
+from metamenth.datatypes.measure import Measure
 
 
 class ContinuousMeasure(AbstractRangeMeasure):

datatypes/exponential_measure.py → metamenth/datatypes/exponential_measure.py

@@ -1,5 +1,5 @@
-from datatypes.interfaces.abstract_range_measure import AbstractRangeMeasure
-from .measure import Measure
+from metamenth.datatypes.interfaces.abstract_range_measure import AbstractRangeMeasure
+from metamenth.datatypes.measure import Measure
 
 
 class ExponentialMeasure(AbstractRangeMeasure):

datatypes/interfaces/abstract_dynamic_entity.py → metamenth/datatypes/interfaces/abstract_dynamic_entity.py

@@ -1,9 +1,9 @@
 from abc import ABC
-from utils import EntityInsert
-from utils import EntityRemover
-from utils import StructureEntitySearch
-from transducers.interfaces.abstract_transducer import AbstractTransducer
-from enumerations import BuildingEntity
+from metamenth.utils import EntityInsert
+from metamenth.utils import EntityRemover
+from metamenth.utils import StructureEntitySearch
+from metamenth.transducers.interfaces.abstract_transducer import AbstractTransducer
+from metamenth.enumerations import BuildingEntity
 from typing import Dict
 
 

datatypes/interfaces/abstract_measure.py → metamenth/datatypes/interfaces/abstract_measure.py

@@ -1,6 +1,6 @@
 from abc import ABC
-from datatypes.measure import Measure
-from enumerations import DataMeasurementType
+from metamenth.datatypes.measure import Measure
+from metamenth.enumerations import DataMeasurementType
 
 
 class AbstractMeasure(ABC):

datatypes/interfaces/abstract_range_measure.py → metamenth/datatypes/interfaces/abstract_range_measure.py

@@ -1,5 +1,5 @@
 from .abstract_measure import AbstractMeasure
-from datatypes.measure import Measure
+from metamenth.datatypes.measure import Measure
 
 
 class AbstractRangeMeasure(AbstractMeasure):

datatypes/linear_measure.py → metamenth/datatypes/linear_measure.py

@@ -1,5 +1,5 @@
-from datatypes.interfaces.abstract_range_measure import AbstractRangeMeasure
-from .measure import Measure
+from metamenth.datatypes.interfaces.abstract_range_measure import AbstractRangeMeasure
+from metamenth.datatypes.measure import Measure
 
 
 class LinearMeasure(AbstractRangeMeasure):

datatypes/measure.py → metamenth/datatypes/measure.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from enumerations import MeasurementUnit
+from metamenth.enumerations import MeasurementUnit
 
 
 @dataclass

datatypes/operational_schedule.py → metamenth/datatypes/operational_schedule.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from dataclasses import dataclass
 from typing import Type
-from datatypes.interfaces.abstract_measure import AbstractMeasure
+from metamenth.datatypes.interfaces.abstract_measure import AbstractMeasure
 from uuid import uuid4
 
 

datatypes/rated_device_measure.py → metamenth/datatypes/rated_device_measure.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
-from enumerations import WaveForm
-from datatypes.interfaces.abstract_measure import AbstractMeasure
+from metamenth.enumerations import WaveForm
+from metamenth.datatypes.interfaces.abstract_measure import AbstractMeasure
 
 
 @dataclass

datatypes/relationships/interfaces/abstract_relationship.py → metamenth/datatypes/relationships/interfaces/abstract_relationship.py

@@ -1,5 +1,5 @@
 from abc import ABC
-from enumerations import RelationshipName
+from metamenth.enumerations import RelationshipName
 
 
 class AbstractRelationship(ABC):

metamenth/datatypes/relationships/one_to_many.py

@@ -0,0 +1,14 @@
+from metamenth.datatypes.relationships.interfaces.abstract_relationship import AbstractRelationship
+from metamenth.enumerations import RelationshipName
+from metamenth.subsystem.hvac_components.interfaces.abstract_hvac_component import AbstractHVACComponent
+from metamenth.subsystem.hvac_components.interfaces.abstract_duct_connected_component import AbstractDuctConnectedComponent
+from typing import Union
+from typing import List
+
+
+class OneToMany(AbstractRelationship):
+
+    def __init__(self, name: RelationshipName, hvac_component: Union[List[AbstractHVACComponent],
+    List[AbstractDuctConnectedComponent]]):
+        super().__init__(name)
+        self.component = hvac_component

datatypes/schedulable_entity.py → metamenth/datatypes/schedulable_entity.py

@@ -1,10 +1,10 @@
 from typing import List
-from datatypes.operational_schedule import OperationalSchedule
-from utils import EntityRemover
-from utils import EntityInsert
-from utils import StructureEntitySearch
+from metamenth.datatypes.operational_schedule import OperationalSchedule
+from metamenth.utils import EntityRemover
+from metamenth.utils import EntityInsert
+from metamenth.utils import StructureEntitySearch
 from typing import Dict
-from enumerations import BuildingEntity
+from metamenth.enumerations import BuildingEntity
 
 
 class SchedulableEntity:

energysystem/electricals/alternator.py → metamenth/energysystem/electricals/alternator.py

@@ -1,6 +1,6 @@
-from energysystem.interfaces.abstract_electrical import AbstractElectrical
-from enumerations import PowerState
-from datatypes.binary_measure import BinaryMeasure
+from metamenth.energysystem.interfaces.abstract_electrical import AbstractElectrical
+from metamenth.enumerations import PowerState
+from metamenth.datatypes.binary_measure import BinaryMeasure
 
 
 class Alternator(AbstractElectrical):

energysystem/electricals/automatic_transfer_switch.py → metamenth/energysystem/electricals/automatic_transfer_switch.py

@@ -1,9 +1,9 @@
-from energysystem.interfaces.abstract_electrical import AbstractElectrical
-from enumerations import PowerState
-from enumerations import ATSPowerSourceType
-from enumerations import ATSOperationMode
-from enumerations import ATSTransitionType
-from enumerations import ATSSwitchingMechanism
+from metamenth.energysystem.interfaces.abstract_electrical import AbstractElectrical
+from metamenth.enumerations import PowerState
+from metamenth.enumerations import ATSPowerSourceType
+from metamenth.enumerations import ATSOperationMode
+from metamenth.enumerations import ATSTransitionType
+from metamenth.enumerations import ATSSwitchingMechanism
 
 
 class AutomaticTransferSwitch(AbstractElectrical):

energysystem/electricals/uninterruptible_power_supply.py → metamenth/energysystem/electricals/uninterruptible_power_supply.py

@@ -1,12 +1,12 @@
-from energysystem.interfaces.abstract_electrical import AbstractElectrical
-from enumerations import PowerState
-from enumerations import UPSPhase
-from datatypes.binary_measure import BinaryMeasure
-from energysystem.storage_system.immobile_storage_energy_system import ImmobileStorageEnergySystem
-from enumerations import BuildingEntity
-from utils import EntityInsert
-from utils import EntityRemover
-from utils import StructureEntitySearch
+from metamenth.energysystem.interfaces.abstract_electrical import AbstractElectrical
+from metamenth.enumerations import PowerState
+from metamenth.enumerations import UPSPhase
+from metamenth.datatypes.binary_measure import BinaryMeasure
+from metamenth.energysystem.storage_system.immobile_storage_energy_system import ImmobileStorageEnergySystem
+from metamenth.enumerations import BuildingEntity
+from metamenth.utils import EntityInsert
+from metamenth.utils import EntityRemover
+from metamenth.utils import StructureEntitySearch
 
 
 class UninterruptiblePowerSupply(AbstractElectrical):