Merge pull request #350 from jgunstone/add-systems

Add systems

Author: RitaLav

BDNS_Abbreviations_Core.qmd

@@ -66,7 +66,7 @@ ifc_core = [x for x in ifc_classes if not ifc_class_is_enum(x)]
 len_ifc_core = len(ifc_core)
 
 init_notebook_mode(all_interactive=True)
-df = pd.read_csv("BDNS_Abbreviations_Register.csv") # .query("'IfcDistributionSystem' in ifc4_3")
+df = pd.read_csv("BDNS_Abbreviations_Register.csv").fillna("") # .query("'IfcDistributionSystem' in ifc4_3")
 df["ifc4_3"] = df.ifc4_3.str.replace("NOTDEFINED", "")
 df = df[df['is_ifc_default']==1]
 len_bdns_mappings= len(df)
@@ -97,4 +97,4 @@ show(df,
     style="table-layout:auto;width:100%;float:left",
     allow_html=True,
 )
-```
+```

BDNS_Abbreviations_Register.csv

@@ -30,7 +30,7 @@ import pandas as pd
 from itables import init_notebook_mode, show
 
 init_notebook_mode(all_interactive=True)
-df = pd.read_csv("BDNS_Abbreviations_Register.csv")
+df = pd.read_csv("BDNS_Abbreviations_Register.csv").fillna("")
 df["ifc4_3"] = df.ifc4_3.str.replace("NOTDEFINED", "")
 df["ifc4_3"] = [
     '<a href="https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/{}" target="_blank">{}</a>'.format(

BDNS_Abbreviations_Register.qmd

@@ -0,0 +1,71 @@
+---
+execute:
+  echo: false
+tbl-cap-location: bottom
+format: 
+  html:
+    page-layout: custom
+toc: false
+jupyter:
+  jupytext:
+    text_representation:
+      extension: .qmd
+      format_name: quarto
+      format_version: '1.0'
+      jupytext_version: 1.16.1
+  kernelspec:
+    display_name: Python 3 (ipykernel)
+    language: python
+    name: python3
+---
+
+# Building Device and Asset Naming Standards initiative
+
+{{< include release.md >}}
+
+# Systems Abbreviation
+
+This sub-list is achieved by filtering and on the ifc4_3 column for classes containing `IfcDistributionSystem`.
+As a minimum BDNS aims to ensure that there is an abbreviation for every [IfcDistributionSystemEnum](https://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcDistributionSystemEnum.htm).
+
+::: {.callout-important}
+## Systems Abbreviations are WIP
+
+If you have comments on those shown please add to discussion here:
+https://github.com/theodi/BDNS/issues/157
+
+:::
+
+```{python}
+import pandas as pd
+import re
+from itables import init_notebook_mode, show
+
+
+def ifc_strip_enum(ifc_class: str) -> str:
+    return re.sub(r"([A-Z0-9_]+_?)$", "", ifc_class)
+
+
+init_notebook_mode(all_interactive=True)
+df = pd.read_csv(
+    "BDNS_Abbreviations_Register.csv"
+).fillna("")
+df["IfcEntity"] = [ifc_strip_enum(x) for x in df.ifc4_3]
+df = df.query("'IfcDistributionSystem' in IfcEntity")
+del df["IfcEntity"]
+
+df["ifc4_3"] = [
+    '<a href="https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/{}" target="_blank">{}</a>'.format(
+        x, x
+    )
+    for x in df["ifc4_3"]
+]
+show(
+    df,
+    buttons=["pageLength", "csvHtml5"],
+    lengthMenu=[20, 50, 100, 500],
+    style="table-layout:auto;width:100%;float:left",
+    allow_html=True,
+)
+
+```

BDNS_Abbreviations_Systems.qmd

@@ -13,6 +13,8 @@ website:
         text: Naming Specification Syntax
       - href: BDNS_Abbreviations_Register.qmd
         text: Abbreviations Register
+      - href: BDNS_Abbreviations_Systems.qmd
+        text: Systems Abbreviations
       - href: BDNS_Abbreviations_Core.qmd
         text: Abbreviations Core
 

_quarto.yml

@@ -0,0 +1,48 @@
+asset_description,asset_abbreviation,can_be_connected,dbo_entity_type,ifc4_3,ifc2x3,is_ifc_default
+system - airconditioning,AIRCON,0,,IfcDistributionSystemAIRCONDITIONING,,1
+system - catenary_system,CATNY,0,,IfcDistributionSystemCATENARY_SYSTEM,,1
+system - chemical,CHEM,0,,IfcDistributionSystemCHEMICAL,,1
+system - chilledwater,CHW,0,,IfcDistributionSystemCHILLEDWATER,,1
+system - communication,COMMS,0,,IfcDistributionSystemCOMMUNICATION,,1
+system - compressedair,CPAIR,0,,IfcDistributionSystemCOMPRESSEDAIR,,1
+system - condenserwater,CDW,0,,IfcDistributionSystemCONDENSERWATER,,1
+system - control,BMS,0,,IfcDistributionSystemCONTROL,,1
+system - conveying,CONVEY,0,,IfcDistributionSystemCONVEYING,,1
+system - domesticcoldwater,DCW,0,,IfcDistributionSystemDOMESTICCOLDWATER,,1
+system - domestichotwater,DHW,0,,IfcDistributionSystemDOMESTICHOTWATER,,1
+system - drainage,DRNG,0,,IfcDistributionSystemDRAINAGE,,1
+system - earthing,EARTH,0,,IfcDistributionSystemEARTHING,,1
+system - electrical (low voltage),LV,0,,IfcDistributionSystemELECTRICAL,,1
+system - electrical (high voltage),HV,0,,IfcDistributionSystemELECTRICAL,,0
+system - electroacoustic,AUDIO,0,,IfcDistributionSystemELECTROACOUSTIC,,1
+system - exhaust,EA,0,,IfcDistributionSystemEXHAUST,,1
+system - fireprotection,SPR,0,,IfcDistributionSystemFIREPROTECTION,,1
+system - fuel,FUEL,0,,IfcDistributionSystemFUEL,,1
+system - gas,GAS,0,,IfcDistributionSystemGAS,,1
+system - hazardous,HAZ,0,,IfcDistributionSystemHAZARDOUS,,1
+system - heating (low template hot water),LTHW,0,,IfcDistributionSystemHEATING,,1
+system - heating (medium template hot water),MTHW,0,,IfcDistributionSystemHEATING,,0
+system - lighting,LTG,0,,IfcDistributionSystemLIGHTING,,1
+system - lightningprotection,LPSY,0,,IfcDistributionSystemLIGHTNINGPROTECTION,,1
+system - mobilenetwork,MOB,0,,IfcDistributionSystemMOBILENETWORK,,1
+system - monitoring system,MS,0,,IfcDistributionSystemMONITORINGSYSTEM,,1
+system - municipalsolidwaste,WSTSOL,0,,IfcDistributionSystemMUNICIPALSOLIDWASTE,,1
+system - oil,OIL,0,,IfcDistributionSystemOIL,,1
+system - operational,OPSUP,0,,IfcDistributionSystemOPERATIONAL,,1
+system - operationaltelephonysystem,PHON,0,,IfcDistributionSystemOPERATIONALTELEPHONYSYSTEM,,1
+system - overhead_contactline_system,OVER,0,,IfcDistributionSystemOVERHEAD_CONTACTLINE_SYSTEM,,1
+system - powergeneration,EGEN,0,,IfcDistributionSystemPOWERGENERATION,,1
+system - rainwater,RW,0,,IfcDistributionSystemRAINWATER,,1
+system - refrigeration,RF,0,,IfcDistributionSystemREFRIGERATION,,1
+system - return_circuit,RETCIR,0,,IfcDistributionSystemRETURN_CIRCUIT,,1
+system - security,SEC,0,,IfcDistributionSystemSECURITY,,1
+system - sewage,SWG,0,,IfcDistributionSystemSEWAGE,,1
+system - signal,SIG,0,,IfcDistributionSystemSIGNAL,,1
+system - stormwater,STORM,0,,IfcDistributionSystemSTORMWATER,,1
+system - telephone,TELE,0,,IfcDistributionSystemTELEPHONE,,1
+system - tv,TV,0,,IfcDistributionSystemTV,,1
+system - vacuum,VAC,0,,IfcDistributionSystemVACUUM,,1
+system - vent,VENTP,0,,IfcDistributionSystemVENT,,1
+system - ventilation,VENT,0,,IfcDistributionSystemVENTILATION,,1
+system - wastewater,WSTWAT,0,,IfcDistributionSystemWASTEWATER,,1
+system - watersupply,WATSUP,0,,IfcDistributionSystemWATERSUPPLY,,1

scripts/25JUL-systems/BDNS_systems.csv

@@ -7,7 +7,10 @@
 
 def read_csv(path: pathlib.Path) -> list[list]:
     """Read a CSV file and return its content as a list of lists."""
-    return list(csv.reader(path.read_text().split("\n")))
+    data = list(csv.reader(path.read_text().split("\n")))
+    if data[-1] == []:
+        data = data[:-1]
+    return data
 
 def write_csv(path: pathlib.Path, data: list[list]) -> None:
     """Write a list of lists to a CSV file."""

scripts/25JUL-update-ifc-mappings/add_can_be_connected.py

@@ -7,7 +7,10 @@
 
 def read_csv(path: pathlib.Path) -> list[list]:
     """Read a CSV file and return its content as a list of lists."""
-    return list(csv.reader(path.read_text().split("\n")))
+    data = list(csv.reader(path.read_text().split("\n")))
+    if data[-1] == []:
+        data = data[:-1]
+    return data
 
 def write_csv(path: pathlib.Path, data: list[list]) -> None:
     """Write a list of lists to a CSV file."""

scripts/25JUL-update-ifc-mappings/add_is_default.py

@@ -5,7 +5,10 @@
 
 def read_csv(path: pathlib.Path) -> list[list]:
     """Read a CSV file and return its content as a list of lists."""
-    return list(csv.reader(path.read_text().split("\n")))
+    data = list(csv.reader(path.read_text().split("\n")))
+    if data[-1] == []:
+        data = data[:-1]
+    return data
 
 def write_csv(path: pathlib.Path, data: list[list]) -> None:
     """Write a list of lists to a CSV file."""

scripts/25JUL-update-ifc-mappings/can_be_connected_to_int.py

@@ -8,7 +8,10 @@
 
 def read_csv(path: pathlib.Path) -> list[list]:
     """Read a CSV file and return its content as a list of lists."""
-    return list(csv.reader(path.read_text().split("\n")))
+    data = list(csv.reader(path.read_text().split("\n")))
+    if data[-1] == []:
+        data = data[:-1]
+    return data
 
 def write_csv(path: pathlib.Path, data: list[list]) -> None:
     """Write a list of lists to a CSV file."""