easysewer 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

easysewer/Rain.py

@@ -4,10 +4,70 @@ Rainfall Data Management Module
 This module handles rainfall data input and processing, including rain gages,
 time series data, and rainfall patterns for the drainage model.
 """
-
+from warnings import warn
 from .utils import *
 
 
+class NamedList:
+    """A list-like collection that allows access by index or name.
+    
+    This class implements common list methods and adds the ability to access items
+    by their name attribute.
+    
+    Attributes:
+        data (list): The underlying list of items
+    """
+    
+    def __init__(self, data=None):
+        self.data = data if data is not None else []
+    
+    def __len__(self):
+        return len(self.data)
+    
+    def __getitem__(self, key):
+        if isinstance(key, int):
+            return self.data[key]
+        elif isinstance(key, str):
+            for item in self.data:
+                if item.name == key:
+                    return item
+            raise KeyError(f"No item found with name '{key}'")
+        else:
+            raise TypeError("Key must be an integer or a string")
+    
+    def __iter__(self):
+        return iter(self.data)
+    
+    def __contains__(self, item):
+        return item in self.data
+    
+    def append(self, item):
+        """Add an item to the collection.
+        
+        Args:
+            item: The item to add
+        """
+        self.data.append(item)
+
+
+class TimeSeriesList(NamedList):
+    """A specialized collection for TimeSeries objects.
+    
+    Inherits all functionality from NamedList and may add TimeSeries-specific
+    methods in the future.
+    """
+    pass
+
+
+class RainGageList(NamedList):
+    """A specialized collection for RainGage objects.
+    
+    Inherits all functionality from NamedList and may add RainGage-specific
+    methods in the future.
+    """
+    pass
+
+
 def parse_swmm_datetime(date_str=None, time_str=None):
     """Convert SWMM date and time strings to minutes since start of day
 
@@ -56,21 +116,23 @@ class RainGage:
 
     Attributes:
         name (str): Unique identifier for the rain gage
-        format (str): Format of the rainfall data (INTENSITY/VOLUME/CUMULATIVE)
+        form (str): Format of the rainfall data (INTENSITY/VOLUME/CUMULATIVE)
         interval (float): Recording time interval
-        snow_catch (float): Snow catch deficiency correction
-        data_source (str): Source of the rainfall data
-        time_series (str): Name of associated time series data
+        source_type (str): Source type (TIMESERIES or FILE)
+        unit (str): Unit for FILE source (e.g., mm)
     """
     def __init__(self):
         self.name = ''
         self.form = ''  # INTENSIFY: mm/h
         self.interval = ''
         self.SCF = 1  # snow catch deficiency correction factor (use 1.0 for no adjustment)
-        self.source = ''  # timeseries name
+        self.source = ''  # timeseries name or file name
+        self.source_type = 'TIMESERIES'  # TIMESERIES or FILE
+        self.station_id = None  # Only for FILE source
+        self.unit = None  # Only for FILE source
 
     def __repr__(self):
-        return f'RainGage<{self.name}>: {self.source}'
+        return f'RainGage<{self.name}>: {self.source} ({self.source_type})'
 
 
 class Rain:
@@ -85,8 +147,8 @@ class Rain:
         ts_list (list): Collection of time series data
     """
     def __init__(self):
-        self.ts_list = []
-        self.gage_list = []
+        self.ts_list = TimeSeriesList()
+        self.gage_list = RainGageList()
 
     def __repr__(self):
         if len(self.gage_list) == 0:
@@ -157,13 +219,34 @@ class Rain:
         # rain gage section
         content = get_swmm_inp_content(filename, '[RAINGAGES]')
         for line in content:
-            name, form, interval, SCF, _, tise = line.split()
-            this_gage = RainGage()
-            this_gage.name = name
-            this_gage.form = form
-            this_gage.interval = interval
-            this_gage.SCF = SCF
-            this_gage.source = tise
+            parts = line.split()
+            if len(parts) < 6:
+                continue  # skip malformed lines
+            source_type = parts[4]
+            if source_type == 'TIMESERIES' and len(parts) == 6:
+                name, form, interval, SCF, source_type, tise = parts
+                this_gage = RainGage()
+                this_gage.name = name
+                this_gage.form = form
+                this_gage.interval = interval
+                this_gage.SCF = SCF
+                this_gage.source_type = source_type
+                this_gage.source = tise
+                # unit remains default
+            elif source_type == 'FILE' and len(parts) == 8:
+                name, form, interval, SCF, source_type, filepath, station_id, unit = parts
+                this_gage = RainGage()
+                this_gage.name = name
+                this_gage.form = form
+                this_gage.interval = interval
+                this_gage.SCF = SCF
+                this_gage.source_type = source_type
+                this_gage.source = filepath
+                this_gage.station_id = station_id
+                this_gage.unit = unit
+            else:
+                warn(f'Failed to add rain gauge for content "{line}".')
+                continue  # skip malformed lines
             self.add_gage(this_gage)
         return 0
 
@@ -202,8 +285,14 @@ class Rain:
                 f.write(';;\n')
 
             f.write('\n\n[RAINGAGES]\n')
-            f.write(';;Name  Format   Interval  SCF  Source    \n')
-            f.write(';;----- -------- --------- ---- ----------\n')
+            f.write(';;Name  Format   Interval  SCF  SourceType  Source    [Unit]\n')
+            f.write(';;----- -------- --------- ---- ----------  ---------- -------\n')
             for gage in self.gage_list:
-                f.write(f'{gage.name}  {gage.form}  {gage.interval}  {gage.SCF}  TIMESERIES  {gage.source}\n')
+                if gage.source_type == 'TIMESERIES':
+                    f.write(f'{gage.name}  {gage.form}  {gage.interval}  {gage.SCF}  TIMESERIES  {gage.source}\n')
+                elif gage.source_type == 'FILE':
+                    f.write(f'{gage.name}  {gage.form}  {gage.interval}  {gage.SCF}  FILE  {gage.source}  {gage.station_id}  {gage.unit}\n')
+                else:
+                    # fallback for unknown type
+                    raise ValueError(f"Unknown source type: {gage.source_type}")
             return 0

easysewer/UDM.py

@@ -11,6 +11,8 @@ The model supports:
 - Handling rainfall and calculation settings
 - Supporting various hydraulic elements like conduits and junctions
 """
+import json
+from pathlib import Path
 
 from .Options import CalculationInformation
 from .Link import LinkList
@@ -18,7 +20,6 @@ from .Node import NodeList
 from .Area import AreaList
 from .Rain import Rain
 from .Curve import ValueList
-import json
 from .utils import get_swmm_inp_content
 
 
@@ -68,32 +69,56 @@ class UrbanDrainageModel:
 
     def to_inp(self, filename):
         """
-        Writes the model to a SWMM .inp file.
-
+        Writes the model to a SWMM .inp file, creating parent directories if needed.
         Args:
-            filename (str): Path to the output .inp file
-
+            filename (str or Path): Path to the output .inp file
         Returns:
-            int: 0 on success
+            int: 0 on success, raises exceptions on failure
+        Raises:
+            OSError: If file operations fail
+            TypeError: If JSON serialization fails
         """
-        with open(filename, 'w', encoding='utf-8') as f:
-            # Write TITLE section first
-            f.write('[TITLE]\n')
-            if self.label:
+        # Convert to Path object if it isn't already
+        filepath = Path(filename)
+
+        # Create parent directories if they don't exist
+        filepath.parent.mkdir(parents=True, exist_ok=True)
+
+        try:
+            with open(filepath, 'w', encoding='utf-8') as f:
+                # Write TITLE section first
+                f.write('[TITLE]\n')
+                if self.label:
+                    try:
+                        # Only attempt JSON if it's a dictionary
+                        if isinstance(self.label, dict):
+                            f.write(json.dumps(self.label, indent=2))
+                        else:
+                            f.write(str(self.label))
+                        f.write('\n\n')
+                    except (TypeError, ValueError) as e:
+                        # Fallback to simple string representation
+                        f.write(str(self.label.get('TITLE', '')) if isinstance(self.label, dict) else str(self.label))
+                        f.write('\n\n')
+
+            # Continue with other sections - now using the same filepath
+            self.calc.write_to_swmm_inp(filepath)
+            self.node.write_to_swmm_inp(filepath)
+            self.link.write_to_swmm_inp(filepath)
+            self.area.write_to_swmm_inp(filepath)
+            self.rain.write_to_swmm_inp(filepath)
+            self.value.write_to_swmm_inp(filepath)
+
+            return 0
+
+        except Exception as e:
+            # Clean up partially written file if there was an error
+            if filepath.exists():
                 try:
-                    f.write(json.dumps(self.label, indent=2))
-                    f.write('\n\n')
+                    filepath.unlink()
                 except:
-                    f.write(str(self.label.get('TITLE', '')) + '\n\n')
-
-        # Continue with other sections
-        self.calc.write_to_swmm_inp(filename)
-        self.node.write_to_swmm_inp(filename)
-        self.link.write_to_swmm_inp(filename)
-        self.area.write_to_swmm_inp(filename)
-        self.rain.write_to_swmm_inp(filename)
-        self.value.write_to_swmm_inp(filename)
-        return 0
+                    pass  # Don't mask the original error
+            raise  # Re-raise the original exception
 
     def read_inp(self, filename):
         """

easysewer/__init__.py

@@ -2,6 +2,6 @@
 pass
 """
 from .UDM import UrbanDrainageModel
-from .UDM import UrbanDrainageModel as Model
+from .ModelAPI import Model
 from .OutputAPI import SWMMOutputAPI
 from .SolverAPI import SWMMSolverAPI

{easysewer-0.0.1.dist-info → easysewer-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: easysewer
-Version: 0.0.1
+Version: 0.0.3
 Summary: An urban drainage modeling toolkit
 Author-email: Yiran Ji <yiranji@zju.edu.cn>
 License-Expression: AGPL-3.0-only

easysewer-0.0.3.dist-info/RECORD

@@ -0,0 +1,20 @@
+easysewer/Area.py,sha256=Hw3xr-XiqAiTGVsG-fH71ovIBNnsRYBwmJrWG9l3YLA,32703
+easysewer/Curve.py,sha256=C5X_CJ9CtuYcUFqdClFkxWYZOYHhQFBxENYg9jC6Dqs,4241
+easysewer/Link.py,sha256=7hyQPme-ibnsgHO1VCjA0WgvPYflMgz3zCF8r5lhZ3g,23749
+easysewer/ModelAPI.py,sha256=qJe8YroVostJ_Xwnlu0P9EdBy8FEFJ6vjev_Jn9sECs,7557
+easysewer/Node.py,sha256=Cbexul4OdPWRhLW9h2fGjeMhLLwtDl0vGwmbACg_Hjs,45547
+easysewer/Options.py,sha256=zsmyDpiQO0Swsrqkzw_vow4lNKbiLsLX_0YQ6XWsSBI,18425
+easysewer/OutputAPI.py,sha256=tD6-6VjBpG-DBlmvVhb9siZ_zgEe1lD1d0h2xPr72Qw,7519
+easysewer/Rain.py,sha256=Bb-SD-j7J0F6lWENsdU6Qc6Nr4ZcrCMOQcbJW3ZcbaQ,10865
+easysewer/SolverAPI.py,sha256=H1KZkS_03Mv2ruSNX6-Rg_fesTwL9O6R5TRCil2eC7o,5612
+easysewer/UDM.py,sha256=A2SCLhiM9LD05VVn0L8S8vIv6WgWxpl6_ckM_5JmRCI,5655
+easysewer/__init__.py,sha256=8i9amFHLOrXYo3vjg6hCQPZ676d650UTCxPkblgyJvk,158
+easysewer/utils.py,sha256=dkK5YwwaE2eLdiaY3YAEg78xv74TU6ff7Q3Rl3ltatI,2847
+easysewer/libs/linux/libswmm5.so,sha256=UI5v1fCZ7LU9zkjLQMJqqJtzDefkFnL1iy3jmAlFsVo,839664
+easysewer/libs/linux/swmm-output.so,sha256=248JHb0PUGyeo3tLj9fL4L114ySTSLBrUUA_k3VHnCQ,30928
+easysewer/libs/win/swmm-output.dll,sha256=tN0K2ZRk7rlQZ-cLxlGLYZ6w269uvc5JuH1oVumADD0,71168
+easysewer/libs/win/swmm5.dll,sha256=7LjGQXUyj8bdVuFzzY8-pObQV0VcUDI5KsAz-hstWls,915968
+easysewer-0.0.3.dist-info/METADATA,sha256=G8-hiKnEacVIA20nHHrMwYbJvBI25EFoe70fpHg6kC4,586
+easysewer-0.0.3.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+easysewer-0.0.3.dist-info/top_level.txt,sha256=YJi065ohgpDZhPb0XuXfE6ExHMhHPlwveH40BgZ7kt4,10
+easysewer-0.0.3.dist-info/RECORD,,

{easysewer-0.0.1.dist-info → easysewer-0.0.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.3.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

easysewer-0.0.1.dist-info/RECORD

@@ -1,19 +0,0 @@
-easysewer/Area.py,sha256=Y7SjlcA9byN4A3fk70D4M4hG8MulE0LLVJLqZ8FDt6c,13010
-easysewer/Curve.py,sha256=C5X_CJ9CtuYcUFqdClFkxWYZOYHhQFBxENYg9jC6Dqs,4241
-easysewer/Link.py,sha256=tZWGPg5EMcii6hfswNPp5MMz3wLdZPzuil9Sjv6OqXc,11802
-easysewer/Node.py,sha256=trtXGPLDk1gkdKMXXwJ1hUOmsS6x2mVr4wh61Lxisqk,14092
-easysewer/Options.py,sha256=zsmyDpiQO0Swsrqkzw_vow4lNKbiLsLX_0YQ6XWsSBI,18425
-easysewer/OutputAPI.py,sha256=tD6-6VjBpG-DBlmvVhb9siZ_zgEe1lD1d0h2xPr72Qw,7519
-easysewer/Rain.py,sha256=Hu_XtEXreIquf4uLxMgAiG_eRNc0OzuansDnZ1ozGAQ,7597
-easysewer/SolverAPI.py,sha256=H1KZkS_03Mv2ruSNX6-Rg_fesTwL9O6R5TRCil2eC7o,5612
-easysewer/UDM.py,sha256=DfEOFRyFR5guy7yEU_ve_XsRypXQ3k2nn5Slc5VAzOc,4385
-easysewer/__init__.py,sha256=XD2zR0vua7-FMz5brRDY9FCzF_QNkPozfrOl7dvYALc,175
-easysewer/utils.py,sha256=dkK5YwwaE2eLdiaY3YAEg78xv74TU6ff7Q3Rl3ltatI,2847
-easysewer/libs/linux/libswmm5.so,sha256=UI5v1fCZ7LU9zkjLQMJqqJtzDefkFnL1iy3jmAlFsVo,839664
-easysewer/libs/linux/swmm-output.so,sha256=248JHb0PUGyeo3tLj9fL4L114ySTSLBrUUA_k3VHnCQ,30928
-easysewer/libs/win/swmm-output.dll,sha256=tN0K2ZRk7rlQZ-cLxlGLYZ6w269uvc5JuH1oVumADD0,71168
-easysewer/libs/win/swmm5.dll,sha256=7LjGQXUyj8bdVuFzzY8-pObQV0VcUDI5KsAz-hstWls,915968
-easysewer-0.0.1.dist-info/METADATA,sha256=GGX1eS11v3_hpeMxS1QsuqwJQi9wfJzEVZfVWTja_es,586
-easysewer-0.0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-easysewer-0.0.1.dist-info/top_level.txt,sha256=YJi065ohgpDZhPb0XuXfE6ExHMhHPlwveH40BgZ7kt4,10
-easysewer-0.0.1.dist-info/RECORD,,