packaging version
This commit is contained in:
parent
ddf8e6dcfe
commit
9700e5ce21
2
.gitignore → hub/.gitignore
vendored
2
.gitignore → hub/.gitignore
vendored
|
@ -6,5 +6,5 @@
|
|||
/data/energy_systems/heat_pumps/*.insel
|
||||
.DS_Store
|
||||
.env
|
||||
logs
|
||||
hub/logs
|
||||
**/__pycache__/
|
|
@ -17,13 +17,13 @@ If the code doesn't pass the quality review, it will be rejected.
|
|||
## Adding new parameters to existing classes
|
||||
|
||||
Adding a new parameter is an easy task. Open the desired class, for example, CityObject:
|
||||
![city object](./docs/img_contributing/img_5.png)
|
||||
![city object](docs/img_contributing/img_5.png)
|
||||
|
||||
Add the name of your new parameter to the list at the constructor and initialize it as desired:
|
||||
![new parameter](./docs/img_contributing/img_6.png)
|
||||
![new parameter](docs/img_contributing/img_6.png)
|
||||
|
||||
At the end of the class, add the corresponding getter and setter. It is very important that they are documented!
|
||||
![getter and setter](./docs/img_contributing/img_7.png)
|
||||
![getter and setter](docs/img_contributing/img_7.png)
|
||||
|
||||
You will see that the name of the file (city_object.py) changes from white to blue. That means that your version is different
|
||||
from that one in the git. Once you finish doing your changes, you should commit and push them to your branch. The name of the file will turn back white.
|
||||
|
@ -31,9 +31,9 @@ from that one in the git. Once you finish doing your changes, you should commit
|
|||
## Creating a new class
|
||||
|
||||
Create a new class in the corresponding folder (if it does not exist, create a new folder ad hoc).
|
||||
![new folder](./docs/img_contributing/img_0.png)
|
||||
![new file](./docs/img_contributing/img_1.png)
|
||||
![add to git](./docs/img_contributing/img_2.png)
|
||||
![new folder](docs/img_contributing/img_0.png)
|
||||
![new file](docs/img_contributing/img_1.png)
|
||||
![add to git](docs/img_contributing/img_2.png)
|
||||
|
||||
And add it to git (the name of the file will turn from red to green).
|
||||
Every new class must have:
|
||||
|
@ -61,7 +61,7 @@ This class models this and does that
|
|||
|
||||
- All imported libraries together at the beginning.
|
||||
|
||||
![new class](./docs/img_contributing/img_3.png)
|
||||
![new class](docs/img_contributing/img_3.png)
|
||||
|
||||
A data class contains properties that describe the data model. Therefore, it should be mainly composed by getters and setters.
|
||||
We would like to avoid having methods in the data classes. All those methods that could be done in the factories must be written there.
|
||||
|
@ -75,7 +75,7 @@ initialization and don’t have setter, while the others are initialized at None
|
|||
|
||||
It is important to highlight that all setters and getters (@property) must have comments to describe the parameters, as shown in the previous image.
|
||||
|
||||
![new class getters and setters](./docs/img_contributing/img_4.png)
|
||||
![new class getters and setters](docs/img_contributing/img_4.png)
|
||||
|
||||
Once you finish doing your changes, you should commit and push them to your branch. The name of the new files will change from green to white.
|
||||
|
||||
|
@ -85,46 +85,46 @@ First, it is required to install a plugin for such purpose. We recommend [GitLab
|
|||
but you are free to choose the one you prefer. In order to install the plug, be sure that you have the latest pycharm version.
|
||||
Go to Help -> Check for Updates... It will ask you to Update the new version, click on Update and Restart and follow the instructions.
|
||||
|
||||
![update pycharm](./docs/img_contributing/img_9.png)
|
||||
![update pycharm](docs/img_contributing/img_9.png)
|
||||
|
||||
Don't forget to look in the bottom-right corner, there you always find the instructions, warnings, errors, announcements...
|
||||
|
||||
![pycharm announcement](./docs/img_contributing/img_10.png)
|
||||
![pycharm announcement](docs/img_contributing/img_10.png)
|
||||
|
||||
Once you updated pycharm, go to File -> Settings... -> Plugins and search for _GitLab Merge Request_ and press Install.
|
||||
|
||||
![pycharm plugins](./docs/img_contributing/img_11.png)
|
||||
![pycharm plugins](docs/img_contributing/img_11.png)
|
||||
|
||||
### Select the project
|
||||
This step needs to be done only the first time.
|
||||
|
||||
Once the plugin is installed, it will appear a new tab at the bottom list called Gitlab Merge Requests as in the image:
|
||||
|
||||
![new tab](./docs/img_contributing/img_12.png)
|
||||
![new tab](docs/img_contributing/img_12.png)
|
||||
|
||||
Click on _Clik to discover servers_ and select the gitlab.concordia.ca.
|
||||
|
||||
![new server](./docs/img_contributing/img_13.png)
|
||||
![new server](docs/img_contributing/img_13.png)
|
||||
|
||||
Observe that in the top-right corner of the tab, the message has changed from _No Repository_ to _Repo: /Guille/libs_.
|
||||
|
||||
![new repo](./docs/img_contributing/img_14.png)
|
||||
![new repo](docs/img_contributing/img_14.png)
|
||||
|
||||
If you now click on Refresh Merge Request (see previous image), you will get a message asking for a token. As you don't have one yet, click on Create token.
|
||||
|
||||
![create token](./docs/img_contributing/img_15.png)
|
||||
![create token](docs/img_contributing/img_15.png)
|
||||
|
||||
You will be sent to the gitlab repository to create a new token. Give a name to it and check all options.
|
||||
You are creating a token that has the same permits as your gitlab account has.
|
||||
|
||||
![create token in gitlab](./docs/img_contributing/img_16.png)
|
||||
![create token in gitlab](docs/img_contributing/img_16.png)
|
||||
|
||||
A new personal access token will be created. Copy and paste it in the Access Token box.
|
||||
A token is a personal and no-transferable key. Don't show it to anyone!
|
||||
|
||||
![copy token](./docs/img_contributing/img_17.png)
|
||||
![copy token](docs/img_contributing/img_17.png)
|
||||
|
||||
![paste token](./docs/img_contributing/img_18.png)
|
||||
![paste token](docs/img_contributing/img_18.png)
|
||||
|
||||
### Create merge request
|
||||
Every time you want to send some changes to the main branch (merge your branch to the main one)
|
||||
|
@ -132,11 +132,11 @@ you will need to follow these steps.
|
|||
|
||||
Right clic on the blanc area and select + Create Merge Request.
|
||||
|
||||
![new merge request](./docs/img_contributing/img_19.png)
|
||||
![new merge request](docs/img_contributing/img_19.png)
|
||||
|
||||
A window will appear with the information of the request:
|
||||
|
||||
![request info](./docs/img_contributing/img_20.png)
|
||||
![request info](docs/img_contributing/img_20.png)
|
||||
|
||||
Clic on Assignees + and look for the project owner, in this case, Guillermo Gutierrez Morote.
|
||||
Select him as assignee and clic OK.
|
||||
|
@ -146,11 +146,11 @@ the email account you use for gitlab with the answer.
|
|||
|
||||
Once the changes are accepted, go back to the main branch by selecting the Git tab (bottom-left). Right clic on Master and select Checkout.
|
||||
|
||||
![checkout master](./docs/img_contributing/img_24.png)
|
||||
![checkout master](docs/img_contributing/img_24.png)
|
||||
|
||||
Now pull (blue arrow), and delete the branch.
|
||||
|
||||
![erase branch](./docs/img_contributing/img_26.png)
|
||||
![erase branch](docs/img_contributing/img_26.png)
|
||||
|
||||
Now you have again the same version as in gitlab. For new changes, create a new branch and repeat the process.
|
||||
|
|
@ -41,8 +41,9 @@ section in persistence/README.md file.
|
|||
2. The .env file should contain the following credentials: database user, database password, database host an,d database port
|
||||
3. Provide the *absolute path* to the .env file to the persistence importers and exporters whenever using them in your code
|
||||
as shown below:
|
||||
|
||||
```python
|
||||
from exports.db_factory import DBFactory
|
||||
from hub.exports.db_factory import DBFactory
|
||||
from pathlib import Path
|
||||
|
||||
dotenv_path = (Path(__file__).parent / '.env').resolve()
|
||||
|
@ -52,8 +53,9 @@ factory = DBFactory(db_name='hub_db', app_env='PROD', dotenv_path=dotenv_path)
|
|||
|
||||
## Create Database Tables ##
|
||||
Use the *DBSetup* class in the persistence package to create the required database tables as described below
|
||||
|
||||
```python
|
||||
from persistence import DBSetup
|
||||
from hub.persistence import DBSetup
|
||||
from pathlib import Path
|
||||
|
||||
dotenv_path = (Path(__file__).parent / '.env').resolve()
|
|
@ -235,7 +235,7 @@ Add the following code to your main.py
|
|||
|
||||
```python
|
||||
|
||||
from imports.geometry_factory import GeometryFactory
|
||||
from hub.imports import GeometryFactory
|
||||
|
||||
city = GeometryFactory('citygml', path='myfile.gml').city
|
||||
```
|
|
@ -1,4 +1,4 @@
|
|||
from helpers import constants as cte
|
||||
from hub.helpers import constants as cte
|
||||
|
||||
nrel_to_function = {
|
||||
'residential': cte.RESIDENTIAL,
|
|
@ -7,16 +7,16 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
import xmltodict
|
||||
from pathlib import Path
|
||||
from catalog_factories.catalog import Catalog
|
||||
from catalog_factories.data_models.construction.window import Window
|
||||
from catalog_factories.data_models.construction.material import Material
|
||||
from catalog_factories.data_models.construction.layer import Layer
|
||||
from catalog_factories.data_models.construction.construction import Construction
|
||||
from catalog_factories.data_models.construction.content import Content
|
||||
from catalog_factories.data_models.construction.archetype import Archetype
|
||||
from catalog_factories.construction.construction_helpers import nrel_to_function
|
||||
from catalog_factories.construction.construction_helpers import reference_standard_to_construction_period
|
||||
from catalog_factories.construction.construction_helpers import nrel_surfaces_types_to_hub_types
|
||||
from hub.catalog_factories.catalog import Catalog
|
||||
from hub.catalog_factories.data_models.construction.window import Window
|
||||
from hub.catalog_factories.data_models.construction.material import Material
|
||||
from hub.catalog_factories.data_models.construction.layer import Layer
|
||||
from hub.catalog_factories.data_models.construction.construction import Construction
|
||||
from hub.catalog_factories.data_models.construction.content import Content
|
||||
from hub.catalog_factories.data_models.construction.archetype import Archetype
|
||||
from hub.catalog_factories.construction.construction_helpers import nrel_to_function
|
||||
from hub.catalog_factories.construction.construction_helpers import reference_standard_to_construction_period
|
||||
from hub.catalog_factories.construction.construction_helpers import nrel_surfaces_types_to_hub_types
|
||||
|
||||
|
||||
class NrelCatalog(Catalog):
|
|
@ -7,7 +7,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
from pathlib import Path
|
||||
from typing import TypeVar
|
||||
from catalog_factories.construction.nrel_catalog import NrelCatalog
|
||||
from hub.catalog_factories.construction.nrel_catalog import NrelCatalog
|
||||
Catalog = TypeVar('Catalog')
|
||||
|
||||
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
|
||||
from catalog_factories.data_models.construction.construction import Construction
|
||||
from hub.catalog_factories.data_models.construction.construction import Construction
|
||||
|
||||
|
||||
class Archetype:
|
|
@ -4,8 +4,8 @@ SPDX - License - Identifier: LGPL - 3.0 - or -later
|
|||
Copyright © 2022 Concordia CERC group
|
||||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
from catalog_factories.data_models.construction.layer import Layer
|
||||
from catalog_factories.data_models.construction.window import Window
|
||||
from hub.catalog_factories.data_models.construction.layer import Layer
|
||||
from hub.catalog_factories.data_models.construction.window import Window
|
||||
|
||||
|
||||
class Construction:
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
|
||||
from catalog_factories.data_models.greenery.soil import Soil as hub_soil
|
||||
from hub.catalog_factories.data_models.greenery.soil import Soil as hub_soil
|
||||
|
||||
|
||||
class Plant:
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
|
||||
from catalog_factories.data_models.greenery.plant import Plant as libs_plant
|
||||
from hub.catalog_factories.data_models.greenery.plant import Plant as libs_plant
|
||||
|
||||
|
||||
class PlantPercentage(libs_plant):
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
|
||||
from catalog_factories.data_models.greenery.plant_percentage import PlantPercentage
|
||||
from hub.catalog_factories.data_models.greenery.plant_percentage import PlantPercentage
|
||||
|
||||
|
||||
class Vegetation:
|
|
@ -7,7 +7,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
from typing import Union, List
|
||||
|
||||
from catalog_factories.data_models.usages.schedule import Schedule
|
||||
from hub.catalog_factories.data_models.usages.schedule import Schedule
|
||||
|
||||
|
||||
class Appliances:
|
|
@ -4,7 +4,7 @@ SPDX - License - Identifier: LGPL - 3.0 - or -later
|
|||
Copyright © 2022 Concordia CERC group
|
||||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
from catalog_factories.data_models.usages.usage import Usage
|
||||
from hub.catalog_factories.data_models.usages.usage import Usage
|
||||
|
||||
|
||||
class Content:
|
|
@ -7,7 +7,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
from typing import Union, List
|
||||
|
||||
from catalog_factories.data_models.usages.schedule import Schedule
|
||||
from hub.catalog_factories.data_models.usages.schedule import Schedule
|
||||
|
||||
|
||||
class Lighting:
|
|
@ -6,7 +6,7 @@ Project Coder Guille Gutierrez Morote Guillermo.GutierrezMorote@concordia.ca
|
|||
"""
|
||||
from typing import Union, List
|
||||
|
||||
from catalog_factories.data_models.usages.schedule import Schedule
|
||||
from hub.catalog_factories.data_models.usages.schedule import Schedule
|
||||
|
||||
|
||||
class Occupancy:
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
from typing import Union, List
|
||||
from catalog_factories.data_models.usages.schedule import Schedule
|
||||
from hub.catalog_factories.data_models.usages.schedule import Schedule
|
||||
|
||||
|
||||
class ThermalControl:
|
|
@ -6,10 +6,10 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
"""
|
||||
from typing import Union
|
||||
|
||||
from catalog_factories.data_models.usages.appliances import Appliances
|
||||
from catalog_factories.data_models.usages.lighting import Lighting
|
||||
from catalog_factories.data_models.usages.ocupancy import Occupancy
|
||||
from catalog_factories.data_models.usages.thermal_control import ThermalControl
|
||||
from hub.catalog_factories.data_models.usages.appliances import Appliances
|
||||
from hub.catalog_factories.data_models.usages.lighting import Lighting
|
||||
from hub.catalog_factories.data_models.usages.ocupancy import Occupancy
|
||||
from hub.catalog_factories.data_models.usages.thermal_control import ThermalControl
|
||||
|
||||
|
||||
class Usage:
|
|
@ -6,14 +6,14 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
"""
|
||||
|
||||
from pyecore.resources import ResourceSet, URI
|
||||
from catalog_factories.greenery.ecore_greenery.greenerycatalog import GreeneryCatalog as gc
|
||||
from catalog_factories.catalog import Catalog
|
||||
from hub.catalog_factories.greenery.ecore_greenery.greenerycatalog import GreeneryCatalog as gc
|
||||
from hub.catalog_factories.catalog import Catalog
|
||||
from pathlib import Path
|
||||
from catalog_factories.data_models.greenery.vegetation import Vegetation as libs_vegetation
|
||||
from catalog_factories.data_models.greenery.plant import Plant as libs_plant
|
||||
from catalog_factories.data_models.greenery.soil import Soil as libs_soil
|
||||
from catalog_factories.data_models.greenery.plant_percentage import PlantPercentage as libs_pp
|
||||
from catalog_factories.data_models.greenery.content import Content as GreeneryContent
|
||||
from hub.catalog_factories.data_models.greenery.vegetation import Vegetation as libs_vegetation
|
||||
from hub.catalog_factories.data_models.greenery.plant import Plant as libs_plant
|
||||
from hub.catalog_factories.data_models.greenery.soil import Soil as libs_soil
|
||||
from hub.catalog_factories.data_models.greenery.plant_percentage import PlantPercentage as libs_pp
|
||||
from hub.catalog_factories.data_models.greenery.content import Content as GreeneryContent
|
||||
|
||||
|
||||
class GreeneryCatalog(Catalog):
|
|
@ -7,7 +7,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
from pathlib import Path
|
||||
from typing import TypeVar
|
||||
from catalog_factories.greenery.greenery_catalog import GreeneryCatalog
|
||||
from hub.catalog_factories.greenery.greenery_catalog import GreeneryCatalog
|
||||
Catalog = TypeVar('Catalog')
|
||||
|
||||
class GreeneryCatalogFactory:
|
|
@ -8,17 +8,17 @@ from typing import Dict
|
|||
|
||||
import pandas as pd
|
||||
|
||||
import helpers.constants as cte
|
||||
from catalog_factories.catalog import Catalog
|
||||
from catalog_factories.data_models.usages.appliances import Appliances
|
||||
from catalog_factories.data_models.usages.content import Content
|
||||
from catalog_factories.data_models.usages.lighting import Lighting
|
||||
from catalog_factories.data_models.usages.ocupancy import Occupancy
|
||||
from catalog_factories.data_models.usages.schedule import Schedule
|
||||
from catalog_factories.data_models.usages.thermal_control import ThermalControl
|
||||
from catalog_factories.data_models.usages.usage import Usage
|
||||
from catalog_factories.usage.usage_helper import UsageHelper
|
||||
from helpers.configuration_helper import ConfigurationHelper as ch
|
||||
import hub.helpers.constants as cte
|
||||
from hub.catalog_factories.catalog import Catalog
|
||||
from hub.catalog_factories.data_models.usages.appliances import Appliances
|
||||
from hub.catalog_factories.data_models.usages.content import Content
|
||||
from hub.catalog_factories.data_models.usages.lighting import Lighting
|
||||
from hub.catalog_factories.data_models.usages.ocupancy import Occupancy
|
||||
from hub.catalog_factories.data_models.usages.schedule import Schedule
|
||||
from hub.catalog_factories.data_models.usages.thermal_control import ThermalControl
|
||||
from hub.catalog_factories.data_models.usages.usage import Usage
|
||||
from hub.catalog_factories.usage.usage_helper import UsageHelper
|
||||
from hub.helpers.configuration_helper import ConfigurationHelper as ch
|
||||
|
||||
|
||||
class ComnetCatalog(Catalog):
|
|
@ -9,16 +9,16 @@ import json
|
|||
import urllib.request
|
||||
import xmltodict
|
||||
|
||||
import helpers.constants as cte
|
||||
from catalog_factories.catalog import Catalog
|
||||
from catalog_factories.data_models.usages.appliances import Appliances
|
||||
from catalog_factories.data_models.usages.content import Content
|
||||
from catalog_factories.data_models.usages.lighting import Lighting
|
||||
from catalog_factories.data_models.usages.ocupancy import Occupancy
|
||||
from catalog_factories.data_models.usages.schedule import Schedule
|
||||
from catalog_factories.data_models.usages.thermal_control import ThermalControl
|
||||
from catalog_factories.data_models.usages.usage import Usage
|
||||
from catalog_factories.usage.usage_helper import UsageHelper
|
||||
import hub.helpers.constants as cte
|
||||
from hub.catalog_factories.catalog import Catalog
|
||||
from hub.catalog_factories.data_models.usages.appliances import Appliances
|
||||
from hub.catalog_factories.data_models.usages.content import Content
|
||||
from hub.catalog_factories.data_models.usages.lighting import Lighting
|
||||
from hub.catalog_factories.data_models.usages.ocupancy import Occupancy
|
||||
from hub.catalog_factories.data_models.usages.schedule import Schedule
|
||||
from hub.catalog_factories.data_models.usages.thermal_control import ThermalControl
|
||||
from hub.catalog_factories.data_models.usages.usage import Usage
|
||||
from hub.catalog_factories.usage.usage_helper import UsageHelper
|
||||
|
||||
|
||||
class NrcanCatalog(Catalog):
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
import sys
|
||||
import helpers.constants as cte
|
||||
import hub.helpers.constants as cte
|
||||
from typing import Dict
|
||||
|
||||
|
|
@ -7,8 +7,8 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
from pathlib import Path
|
||||
from typing import TypeVar
|
||||
from catalog_factories.usage.comnet_catalog import ComnetCatalog
|
||||
from catalog_factories.usage.nrcan_catalog import NrcanCatalog
|
||||
from hub.catalog_factories.usage.comnet_catalog import ComnetCatalog
|
||||
from hub.catalog_factories.usage.nrcan_catalog import NrcanCatalog
|
||||
Catalog = TypeVar('Catalog')
|
||||
|
||||
|
|
@ -7,7 +7,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
|
||||
import uuid
|
||||
from typing import List, TypeVar
|
||||
from city_model_structure.attributes.time_series import TimeSeries
|
||||
from hub.city_model_structure.attributes.time_series import TimeSeries
|
||||
Edge = TypeVar('Edge')
|
||||
|
||||
|
|
@ -13,9 +13,9 @@ import numpy as np
|
|||
from trimesh import Trimesh
|
||||
import trimesh.intersections
|
||||
|
||||
from city_model_structure.attributes.plane import Plane
|
||||
from city_model_structure.attributes.point import Point
|
||||
import helpers.constants as cte
|
||||
from hub.city_model_structure.attributes.plane import Plane
|
||||
from hub.city_model_structure.attributes.point import Point
|
||||
import hub.helpers.constants as cte
|
||||
|
||||
|
||||
class Polygon:
|
|
@ -11,7 +11,7 @@ import sys
|
|||
import math
|
||||
import numpy as np
|
||||
from trimesh import Trimesh
|
||||
from helpers.configuration_helper import ConfigurationHelper
|
||||
from hub.helpers.configuration_helper import ConfigurationHelper
|
||||
|
||||
|
||||
class Polyhedron:
|
|
@ -6,7 +6,7 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.attributes.record import Record
|
||||
from hub.city_model_structure.attributes.record import Record
|
||||
|
||||
|
||||
class TimeSeries:
|
|
@ -8,12 +8,12 @@ Code contributors: Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concord
|
|||
|
||||
from typing import List, Union
|
||||
import numpy as np
|
||||
import helpers.constants as cte
|
||||
from city_model_structure.building_demand.surface import Surface
|
||||
from city_model_structure.city_object import CityObject
|
||||
from city_model_structure.building_demand.household import Household
|
||||
from city_model_structure.building_demand.internal_zone import InternalZone
|
||||
from city_model_structure.attributes.polyhedron import Polyhedron
|
||||
import hub.helpers.constants as cte
|
||||
from hub.city_model_structure.building_demand.surface import Surface
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.building_demand.household import Household
|
||||
from hub.city_model_structure.building_demand.internal_zone import InternalZone
|
||||
from hub.city_model_structure.attributes.polyhedron import Polyhedron
|
||||
|
||||
|
||||
class Building(CityObject):
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
from typing import Union, List
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
|
||||
|
||||
class Appliances:
|
|
@ -6,7 +6,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import Union, List
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
|
||||
|
||||
class InternalGain:
|
|
@ -7,10 +7,10 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
|
||||
import uuid
|
||||
from typing import Union, List
|
||||
from city_model_structure.building_demand.usage_zone import UsageZone
|
||||
from city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
from city_model_structure.attributes.polyhedron import Polyhedron
|
||||
from city_model_structure.energy_systems.hvac_system import HvacSystem
|
||||
from hub.city_model_structure.building_demand.usage_zone import UsageZone
|
||||
from hub.city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
from hub.city_model_structure.attributes.polyhedron import Polyhedron
|
||||
from hub.city_model_structure.energy_systems.hvac_system import HvacSystem
|
||||
|
||||
|
||||
class InternalZone:
|
|
@ -6,7 +6,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
"""
|
||||
import uuid
|
||||
from typing import Union
|
||||
from city_model_structure.building_demand.material import Material
|
||||
from hub.city_model_structure.building_demand.material import Material
|
||||
|
||||
|
||||
class Layer:
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
from typing import Union, List
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
|
||||
|
||||
class Lighting:
|
|
@ -5,8 +5,8 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
from typing import Union, List
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
from city_model_structure.building_demand.occupant import Occupant
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
from hub.city_model_structure.building_demand.occupant import Occupant
|
||||
|
||||
|
||||
class Occupancy:
|
|
@ -7,9 +7,9 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
|
||||
from __future__ import annotations
|
||||
from typing import List
|
||||
from city_model_structure.building_demand.surface import Surface
|
||||
from city_model_structure.building_demand.thermal_boundary import ThermalBoundary
|
||||
from city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
from hub.city_model_structure.building_demand.surface import Surface
|
||||
from hub.city_model_structure.building_demand.thermal_boundary import ThermalBoundary
|
||||
from hub.city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
|
||||
|
||||
class Storey:
|
|
@ -10,12 +10,12 @@ from __future__ import annotations
|
|||
import uuid
|
||||
import numpy as np
|
||||
from typing import List, Union
|
||||
from city_model_structure.attributes.polygon import Polygon
|
||||
from city_model_structure.attributes.plane import Plane
|
||||
from city_model_structure.attributes.point import Point
|
||||
from city_model_structure.greenery.vegetation import Vegetation
|
||||
from city_model_structure.building_demand.thermal_boundary import ThermalBoundary
|
||||
import helpers.constants as cte
|
||||
from hub.city_model_structure.attributes.polygon import Polygon
|
||||
from hub.city_model_structure.attributes.plane import Plane
|
||||
from hub.city_model_structure.attributes.point import Point
|
||||
from hub.city_model_structure.greenery.vegetation import Vegetation
|
||||
from hub.city_model_structure.building_demand.thermal_boundary import ThermalBoundary
|
||||
import hub.helpers.constants as cte
|
||||
|
||||
|
||||
class Surface:
|
|
@ -8,11 +8,11 @@ Code contributors: Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concord
|
|||
|
||||
import uuid
|
||||
from typing import List, Union, TypeVar
|
||||
from helpers.configuration_helper import ConfigurationHelper as ch
|
||||
import helpers.constants as cte
|
||||
from city_model_structure.building_demand.layer import Layer
|
||||
from city_model_structure.building_demand.thermal_opening import ThermalOpening
|
||||
from city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
from hub.helpers.configuration_helper import ConfigurationHelper as ch
|
||||
import hub.helpers.constants as cte
|
||||
from hub.city_model_structure.building_demand.layer import Layer
|
||||
from hub.city_model_structure.building_demand.thermal_opening import ThermalOpening
|
||||
from hub.city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
|
||||
Surface = TypeVar('Surface')
|
||||
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
from typing import Union, List
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
|
||||
|
||||
class ThermalControl:
|
|
@ -7,7 +7,7 @@ Code contributors: Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concord
|
|||
"""
|
||||
import uuid
|
||||
from typing import TypeVar, Union
|
||||
from helpers.configuration_helper import ConfigurationHelper as ch
|
||||
from hub.helpers.configuration_helper import ConfigurationHelper as ch
|
||||
|
||||
Polygon = TypeVar('Polygon')
|
||||
|
|
@ -10,13 +10,13 @@ import uuid
|
|||
import copy
|
||||
import numpy
|
||||
from typing import List, Union, TypeVar
|
||||
from city_model_structure.building_demand.occupancy import Occupancy
|
||||
from city_model_structure.building_demand.appliances import Appliances
|
||||
from city_model_structure.building_demand.lighting import Lighting
|
||||
from city_model_structure.building_demand.internal_gain import InternalGain
|
||||
from city_model_structure.building_demand.thermal_control import ThermalControl
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
import helpers.constants as cte
|
||||
from hub.city_model_structure.building_demand.occupancy import Occupancy
|
||||
from hub.city_model_structure.building_demand.appliances import Appliances
|
||||
from hub.city_model_structure.building_demand.lighting import Lighting
|
||||
from hub.city_model_structure.building_demand.internal_gain import InternalGain
|
||||
from hub.city_model_structure.building_demand.thermal_control import ThermalControl
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
import hub.helpers.constants as cte
|
||||
|
||||
ThermalBoundary = TypeVar('ThermalBoundary')
|
||||
InternalZone = TypeVar('InternalZone')
|
|
@ -7,12 +7,12 @@ Code contributors: Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
"""
|
||||
import uuid
|
||||
from typing import Union, List
|
||||
import helpers.constants as cte
|
||||
from city_model_structure.building_demand.occupancy import Occupancy
|
||||
from city_model_structure.building_demand.lighting import Lighting
|
||||
from city_model_structure.building_demand.appliances import Appliances
|
||||
from city_model_structure.building_demand.thermal_control import ThermalControl
|
||||
from city_model_structure.building_demand.internal_gain import InternalGain
|
||||
import hub.helpers.constants as cte
|
||||
from hub.city_model_structure.building_demand.occupancy import Occupancy
|
||||
from hub.city_model_structure.building_demand.lighting import Lighting
|
||||
from hub.city_model_structure.building_demand.appliances import Appliances
|
||||
from hub.city_model_structure.building_demand.thermal_control import ThermalControl
|
||||
from hub.city_model_structure.building_demand.internal_gain import InternalGain
|
||||
|
||||
|
||||
class UsageZone:
|
|
@ -7,7 +7,7 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
|
||||
from typing import List, TypeVar
|
||||
|
||||
from city_model_structure.city_objects_cluster import CityObjectsCluster
|
||||
from hub.city_model_structure.city_objects_cluster import CityObjectsCluster
|
||||
|
||||
CityObject = TypeVar('CityObject')
|
||||
|
|
@ -6,11 +6,11 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.city_object import CityObject
|
||||
from city_model_structure.attributes.polygon import Polygon
|
||||
from city_model_structure.transport.bus_network import BusNetwork
|
||||
from city_model_structure.transport.bus_node import BusNode
|
||||
from city_model_structure.transport.bus import Bus
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.attributes.polygon import Polygon
|
||||
from hub.city_model_structure.transport.bus_network import BusNetwork
|
||||
from hub.city_model_structure.transport.bus_node import BusNode
|
||||
from hub.city_model_structure.transport.bus import Bus
|
||||
|
||||
|
||||
class BusSystem(CityObject):
|
|
@ -14,20 +14,20 @@ import pyproj
|
|||
from typing import List, Union
|
||||
from pyproj import Transformer
|
||||
from pathlib import Path
|
||||
from city_model_structure.building import Building
|
||||
from city_model_structure.city_object import CityObject
|
||||
from city_model_structure.city_objects_cluster import CityObjectsCluster
|
||||
from city_model_structure.buildings_cluster import BuildingsCluster
|
||||
from city_model_structure.fuel import Fuel
|
||||
from city_model_structure.iot.station import Station
|
||||
from city_model_structure.level_of_detail import LevelOfDetail
|
||||
from city_model_structure.machine import Machine
|
||||
from city_model_structure.parts_consisting_building import PartsConsistingBuilding
|
||||
from city_model_structure.subway_entrance import SubwayEntrance
|
||||
from helpers.geometry_helper import GeometryHelper
|
||||
from helpers.location import Location
|
||||
from city_model_structure.energy_system import EnergySystem
|
||||
from city_model_structure.lca_material import LcaMaterial
|
||||
from hub.city_model_structure.building import Building
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.city_objects_cluster import CityObjectsCluster
|
||||
from hub.city_model_structure.buildings_cluster import BuildingsCluster
|
||||
from hub.city_model_structure.fuel import Fuel
|
||||
from hub.city_model_structure.iot.station import Station
|
||||
from hub.city_model_structure.level_of_detail import LevelOfDetail
|
||||
from hub.city_model_structure.machine import Machine
|
||||
from hub.city_model_structure.parts_consisting_building import PartsConsistingBuilding
|
||||
from hub.city_model_structure.subway_entrance import SubwayEntrance
|
||||
from hub.helpers.geometry_helper import GeometryHelper
|
||||
from hub.helpers.location import Location
|
||||
from hub.city_model_structure.energy_system import EnergySystem
|
||||
from hub.city_model_structure.lca_material import LcaMaterial
|
||||
|
||||
|
||||
class City:
|
|
@ -5,13 +5,12 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
|
||||
import math
|
||||
from typing import List, Union
|
||||
|
||||
from city_model_structure.iot.sensor import Sensor
|
||||
from city_model_structure.building_demand.surface import Surface
|
||||
from city_model_structure.attributes.polyhedron import Polyhedron
|
||||
from helpers.configuration_helper import ConfigurationHelper
|
||||
from hub.city_model_structure.iot.sensor import Sensor
|
||||
from hub.city_model_structure.building_demand.surface import Surface
|
||||
from hub.city_model_structure.attributes.polyhedron import Polyhedron
|
||||
from hub.helpers.configuration_helper import ConfigurationHelper
|
||||
|
||||
|
||||
class CityObject:
|
|
@ -7,8 +7,8 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
|
||||
from abc import ABC
|
||||
from typing import List
|
||||
from city_model_structure.iot.sensor import Sensor
|
||||
from city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.iot.sensor import Sensor
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
|
||||
|
||||
class CityObjectsCluster(ABC, CityObject):
|
|
@ -6,9 +6,9 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
Code contributors: Peter Yefi peteryefi@gmail.com
|
||||
"""
|
||||
|
||||
from city_model_structure.city_object import CityObject
|
||||
from city_model_structure.energy_systems.air_source_hp import AirSourceHP
|
||||
from city_model_structure.energy_systems.water_to_water_hp import WaterToWaterHP
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.energy_systems.air_source_hp import AirSourceHP
|
||||
from hub.city_model_structure.energy_systems.water_to_water_hp import WaterToWaterHP
|
||||
|
||||
|
||||
class EnergySystem(CityObject):
|
|
@ -7,7 +7,7 @@ Code contributors: Peter Yefi peteryefi@gmail.com
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.energy_systems.heat_pump import HeatPump
|
||||
from hub.city_model_structure.energy_systems.heat_pump import HeatPump
|
||||
|
||||
|
||||
class AirSourceHP(HeatPump):
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
from typing import Union, List
|
||||
from city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
from hub.city_model_structure.building_demand.thermal_zone import ThermalZone
|
||||
|
||||
|
||||
class HvacSystem:
|
|
@ -6,7 +6,7 @@ Project Coder Peter Yefi peteryefi@gmail.com
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.energy_systems.heat_pump import HeatPump
|
||||
from hub.city_model_structure.energy_systems.heat_pump import HeatPump
|
||||
|
||||
|
||||
class WaterToWaterHP(HeatPump):
|
|
@ -6,7 +6,7 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.greenery.soil import Soil
|
||||
from hub.city_model_structure.greenery.soil import Soil
|
||||
|
||||
|
||||
class Plant:
|
|
@ -6,8 +6,8 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.greenery.soil import Soil
|
||||
from city_model_structure.greenery.plant import Plant
|
||||
from hub.city_model_structure.greenery.soil import Soil
|
||||
from hub.city_model_structure.greenery.plant import Plant
|
||||
|
||||
|
||||
class Vegetation:
|
|
@ -5,9 +5,9 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
||||
"""
|
||||
|
||||
from helpers.location import Location
|
||||
from city_model_structure.iot.sensor_measure import SensorMeasure
|
||||
from city_model_structure.iot.sensor_type import SensorType
|
||||
from hub.helpers.location import Location
|
||||
from hub.city_model_structure.iot.sensor_measure import SensorMeasure
|
||||
from hub.city_model_structure.iot.sensor_type import SensorType
|
||||
|
||||
|
||||
class Sensor:
|
|
@ -6,7 +6,7 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
"""
|
||||
import uuid
|
||||
|
||||
from city_model_structure.iot.sensor import Sensor
|
||||
from hub.city_model_structure.iot.sensor import Sensor
|
||||
|
||||
|
||||
class Station:
|
|
@ -4,7 +4,7 @@ SPDX - License - Identifier: LGPL - 3.0 - or -later
|
|||
Copyright © 2022 Concordia CERC group
|
||||
Project Coder Atiya atiya.atiya@mail.concordia.ca
|
||||
"""
|
||||
from city_model_structure.machine import Machine
|
||||
from hub.city_model_structure.machine import Machine
|
||||
|
||||
|
||||
class LcaCalculations:
|
|
@ -8,9 +8,9 @@ Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|||
import uuid
|
||||
from typing import List
|
||||
|
||||
from city_model_structure.city_object import CityObject
|
||||
from city_model_structure.attributes.edge import Edge
|
||||
from city_model_structure.attributes.node import Node
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.attributes.edge import Edge
|
||||
from hub.city_model_structure.attributes.node import Node
|
||||
|
||||
|
||||
class Network(CityObject):
|
|
@ -6,7 +6,7 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List, TypeVar
|
||||
from city_model_structure.city_objects_cluster import CityObjectsCluster
|
||||
from hub.city_model_structure.city_objects_cluster import CityObjectsCluster
|
||||
CityObject = TypeVar('CityObject')
|
||||
|
||||
|
|
@ -4,7 +4,7 @@ SPDX - License - Identifier: LGPL - 3.0 - or -later
|
|||
Copyright © 2022 Concordia CERC group
|
||||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
from city_model_structure.city_object import CityObject
|
||||
from hub.city_model_structure.city_object import CityObject
|
||||
|
||||
|
||||
class SubwayEntrance(CityObject):
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
|
||||
from city_model_structure.attributes.schedule import Schedule
|
||||
from hub.city_model_structure.attributes.schedule import Schedule
|
||||
|
||||
|
||||
class Bus:
|
|
@ -5,7 +5,7 @@ Copyright © 2022 Concordia CERC group
|
|||
Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
||||
"""
|
||||
|
||||
from city_model_structure.transport.bus_node import BusNode
|
||||
from hub.city_model_structure.transport.bus_node import BusNode
|
||||
|
||||
|
||||
class BusDepot(BusNode):
|
|
@ -6,7 +6,7 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List, TypeVar
|
||||
from city_model_structure.attributes.edge import Edge
|
||||
from hub.city_model_structure.attributes.edge import Edge
|
||||
|
||||
BusNode = TypeVar('BusNode')
|
||||
|
|
@ -6,9 +6,9 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
"""
|
||||
|
||||
from typing import List
|
||||
from city_model_structure.network import Network
|
||||
from city_model_structure.transport.bus_edge import BusEdge
|
||||
from city_model_structure.transport.bus_node import BusNode
|
||||
from hub.city_model_structure.network import Network
|
||||
from hub.city_model_structure.transport.bus_edge import BusEdge
|
||||
from hub.city_model_structure.transport.bus_node import BusNode
|
||||
|
||||
|
||||
class BusNetwork(Network):
|
|
@ -7,8 +7,8 @@ Project Coder Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|||
|
||||
from typing import List, TypeVar
|
||||
|
||||
from city_model_structure.attributes.node import Node
|
||||
from city_model_structure.attributes.point import Point
|
||||
from hub.city_model_structure.attributes.node import Node
|
||||
from hub.city_model_structure.attributes.point import Point
|
||||
|
||||
BusEdge = TypeVar('BusEdge')
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user