Fix some issue in docstrings and documentation

Author: hqrrr

carbonfly/case.py

@@ -155,7 +155,7 @@ def build_case(
     """
     Build an OpenFOAM case folder structure and write key dictionaries/fields.
 
-    High-level steps:
+    Steps:
         1) Mesh each CFGeo.brep and export a multi-solid ASCII STL.
         2) Optionally write `system/blockMeshDict`.
         3) Optionally write `system/surfaceFeaturesDict` and `system/snappyHexMeshDict`.
@@ -180,7 +180,8 @@ def build_case(
         internal_G: Optional internalField for G.
         internal_Ydefault: Optional internalField for Ydefault.
         write_blockmesh (bool): If True, write `system/blockMeshDict`.
-        padding_m (float): Extra margin (in meters) added around the union of all CFGeo bounding boxes when computing the blockMesh domain extents.
+        padding_m (float): Extra margin (in meters) added around the union of all CFGeo bounding boxes
+            when computing the blockMesh domain extents.
         cell_size_m (float): Target cell size (m) used to derive blockMesh cell counts.
         write_snappy (bool): If True, write snappyHexMesh-related dictionaries.
         snap (bool): `snap` switch in snappyHexMeshDict.

carbonfly/iaq.py

@@ -65,50 +65,50 @@ def iaq_co2(
 
     Notes:
         - EN: European standard CEN/EN 16798-1, based on german version DIN EN 16798-1:2019 (Page 55).
-        Evaluation based on CO2 concentration differences between indoors and outdoors.
-            - [Index = 1] Category I: delta(CO2) <= 550 ppm
-            - [Index = 2] Category II: delta(CO2) <= 800 ppm
-            - [Index = 3] Category III: delta(CO2) <= 1350 ppm
-            - [Index = 4] Category IV: delta(CO2) > 1350 ppm
+            Evaluation based on CO2 concentration differences between indoors and outdoors.
+                - [Index = 1] Category I: delta(CO2) <= 550 ppm
+                - [Index = 2] Category II: delta(CO2) <= 800 ppm
+                - [Index = 3] Category III: delta(CO2) <= 1350 ppm
+                - [Index = 4] Category IV: delta(CO2) > 1350 ppm
 
         - LEHB: Japanese law for environmental health in buildings (LEHB).
-        Evaluation based on CO2 concentration indoors.
-            - [Index = 1] Acceptable: CO2 <= 1000 ppm
-            - [Index = 2] Unacceptable: CO2 > 1000 ppm
+            Evaluation based on CO2 concentration indoors.
+                - [Index = 1] Acceptable: CO2 <= 1000 ppm
+                - [Index = 2] Unacceptable: CO2 > 1000 ppm
 
         - SS: Singapore standard SS 554:2016 (Page 22).
-        Evaluation based on CO2 concentration differences between indoors and outdoors.
-            - [Index = 1] Acceptable: delta(CO2) <= 700 ppm
-            - [Index = 2] Unacceptable: delta(CO2) > 700 ppm
+            Evaluation based on CO2 concentration differences between indoors and outdoors.
+                - [Index = 1] Acceptable: delta(CO2) <= 700 ppm
+                - [Index = 2] Unacceptable: delta(CO2) > 700 ppm
 
         - HK: Hong Kong Environmental Protection Department.
-        "Hongkong Guidance Notes for the Management of Indoor Air Quality in Offices and Public Places" (Page 17).
-        Evaluation based on CO2 concentration indoors (averaging time 8-hour). Here the average is changed
-        to an instantaneous evaluation for each measurment.
-            - [Index = 1] Excellent Class: CO2 <= 800 ppm
-            - [Index = 2] Good Class: CO2 <= 1000 ppm
-            - [Index = 3] Unacceptable: CO2 > 1000 ppm
+            "Hongkong Guidance Notes for the Management of Indoor Air Quality in Offices and Public Places" (Page 17).
+            Evaluation based on CO2 concentration indoors (averaging time 8-hour). Here the average is changed
+            to an instantaneous evaluation for each measurment.
+                - [Index = 1] Excellent Class: CO2 <= 800 ppm
+                - [Index = 2] Good Class: CO2 <= 1000 ppm
+                - [Index = 3] Unacceptable: CO2 > 1000 ppm
 
         - UBA: German environmental protection agency (Umweltbundesamt).
-        "Gesundheitsschutz 11-2008: Gesundheitliche Bewertung von Kohlendioxid in der Innenraumluft" (Page 1368).
-        Evaluation based on CO2 concentration indoors.
-            - [Index = 1] Hygienically safe: CO2 < 1000 ppm
-            - [Index = 2] Hygienically conspicuous: CO2 <= 2000 ppm
-            - [Index = 3] Hygienically unacceptable: CO2 > 2000 ppm
+            "Gesundheitsschutz 11-2008: Gesundheitliche Bewertung von Kohlendioxid in der Innenraumluft" (Page 1368).
+            Evaluation based on CO2 concentration indoors.
+                - [Index = 1] Hygienically safe: CO2 < 1000 ppm
+                - [Index = 2] Hygienically conspicuous: CO2 <= 2000 ppm
+                - [Index = 3] Hygienically unacceptable: CO2 > 2000 ppm
 
         - DOSH: Department of Occupational Safety and Health (DOSH) Malaysia.
-        "Industry Code of Practice on Indoor Air Quality 2010 (ICOP IAQ 2010)."
-        Evaluation based on CO2 concentration indoors.
-            - [Index = 1] Acceptable: CO2 <= 1000 ppm
-            - [Index = 2] Unacceptable: CO2 > 1000 ppm
+            "Industry Code of Practice on Indoor Air Quality 2010 (ICOP IAQ 2010)."
+            Evaluation based on CO2 concentration indoors.
+                - [Index = 1] Acceptable: CO2 <= 1000 ppm
+                - [Index = 2] Unacceptable: CO2 > 1000 ppm
 
         - NBR: Brazilian standard ABNT NBR 16401-3:2008
             "Air-conditioning installations – Central and unitary systems – Part 3: Indoor air quality"
             and ABNT NBR 17037:2023
             "Indoor air quality in artificially heated non-residential environments – Referential standards"
-        Evaluation based on CO2 concentration differences between indoors and outdoors.
-            - [Index = 1] Acceptable: delta(CO2) <= 700 ppm
-            - [Index = 2] Unacceptable: delta(CO2) > 700 ppm
+            Evaluation based on CO2 concentration differences between indoors and outdoors.
+                - [Index = 1] Acceptable: delta(CO2) <= 700 ppm
+                - [Index = 2] Unacceptable: delta(CO2) > 700 ppm
     """
     standards = ["EN", "LEHB", "SS", "HK", "UBA", "DOSH", "NBR"]
     if standard not in standards:

carbonfly/utils.py

@@ -234,14 +234,20 @@ def wind_pressure_en1991(
         zone: External pressure zones, A/B/C on side/roof edges along the flow, D windward face, and E leeward face.
             Schematic (Fig. 7.5) see Notes.
         terrain: terrain type, 0/1/2/3/4, default: 4, corresponding to Type 0/I/II/III/IV:
+
             0: Sea, coastal area exposed to the open sea.
+
             1: Lakes or area with negligible vegetation and without obstacles.
+
             2: Area with low vegetation such as grass and isolated obstacles (trees, buildings) with separations of
                 at least 20 obstacle heights.
+
             3: Area with regular cover of vegetation or buildings or with isolated obstacles with separations of
                 maximum 20 obstacle heights (such as villages, suburban terrain, permanent forest).
+
             4: Area in which at least 15 % of the surface is covered with buildings and their average height
                 exceeds 15 m.
+
         c_dir: directional factor, for various wind directions may be found in the National Annex.
             The recommended value is 1.0.
         c_season: season factor, may be given in the National Annex. The recommended value is 1.0.

docs/source/api.rst

@@ -1,8 +1,11 @@
 API Documentation
 =================
 
+This section contains the complete API reference of the **Carbonfly** Python package.
+It covers geometry handling in Rhino/Grasshopper, OpenFOAM case generation,
+WSL-based execution, and post-processing utilities.
+
 .. toctree::
    :maxdepth: 4
-   :hidden:
 
    carbonfly