Installation config; #204, #162, #163, #184, #180

Author: cbuahin

python/CMakeLists.txt

@@ -13,6 +13,7 @@ project(
 # Define build options
 find_package(PythonExtensions REQUIRED)
 find_package(Cython REQUIRED)
+find_package(Python3 REQUIRED COMPONENTS Interpreter Development)
 
 # Append local dir to module search path
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)

python/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+recursive-include *.py
+recursive-include docs *.rst
+recursive-include tests *.csv
+global-exclude *.pyc

python/epaswmm/CMakeLists.txt

@@ -2,23 +2,20 @@
 # Created by: Caleb Buahin (EPA/ORD/CESER/WID)
 # Created on: 2024-11-19
 
-# Find Python extensions
-find_package(PythonExtensions REQUIRED)
-
 # Add Cython targets for epaswmm
-add_cython_target(epaswmm epaswmm.pyx CXX PY3)
+add_cython_target(_epaswmm _epaswmm.pyx CXX PY3)
 
 # Create Python extension modules
-add_library(epaswmm MODULE ${epaswmm})
+add_library(_epaswmm MODULE ${_epaswmm})
 
-python_extension_module(epaswmm)
+python_extension_module(_epaswmm)
 
 # Install the epaswmm module
-install(TARGETS epaswmm LIBRARY DESTINATION epaswmm)
+install(TARGETS _epaswmm LIBRARY DESTINATION epaswmm)
 
 # Include the current source directory
 target_include_directories(
-    epaswmm PRIVATE
+    _epaswmm PRIVATE
     ${CMAKE_CURRENT_SOURCE_DIR}
 )
 

python/epaswmm/__init__.py

@@ -19,6 +19,4 @@
     else:
         os.environ["PATH"] = lib_dir + ";" + os.environ["PATH"]
 
-from .epaswmm import *
-from . import solver
-from . import output
+from epaswmm import *

python/epaswmm/epaswmm.pyi python/epaswmm/_epaswmm.pyi

@@ -0,0 +1,15 @@
+
+# Description: Cython module for encoding and decoding SWMM datetimes
+# Created by: Caleb Buahin (EPA/ORD/CESER/WID)
+# Created on: 2024-11-19
+
+# cython: language_level=3
+
+
+# python imports
+
+# third-party imports
+
+# project imports
+from epaswmm cimport epaswmm
+

python/epaswmm/_epaswmm.pyx

@@ -4,14 +4,7 @@
 
 # cython: language_level=3
 # python imports
-from cpython.datetime cimport datetime
 
 # third-party imports
 
 # project imports
-
-# Define the number of days since 01/01/00
-cpdef double encode_swmm_datetime(datetime pdatetime)
-
-# Define the number of days since 01/01/00
-cpdef datetime decode_swmm_datetime(double swmm_datetime)

python/epaswmm/epaswmm.pxd

@@ -3,27 +3,23 @@
 # Created by: Caleb Buahin (EPA/ORD/CESER/WID)
 # Created on: 2024-11-19
 
-# Find Python
-find_package(Python3 REQUIRED COMPONENTS Development)
-find_package(PythonExtensions REQUIRED)
-
-add_cython_target(output output.pyx LANGUAGE CXX PY3)
+add_cython_target(_output _output.pyx LANGUAGE CXX PY3)
 
 # Add Cython target
-add_library(output MODULE ${output})
+add_library(_output MODULE ${_output})
 
 # Add library
-target_link_libraries(output swmm-output)
+target_link_libraries(_output swmm-output)
 
 # Specify that this is a Python extension module
-python_extension_module(output)
+python_extension_module(_output)
 
 # Install the target
-install(TARGETS output LIBRARY DESTINATION epaswmm/output)
+install(TARGETS _output LIBRARY DESTINATION epaswmm/output)
 
 # Include directories
 target_include_directories(
-    output PRIVATE 
+    _output PUBLIC 
     ${CMAKE_CURRENT_SOURCE_DIR}
     $<TARGET_PROPERTY:swmm-output,INCLUDE_DIRECTORIES>
 )

python/epaswmm/epaswmm.pyx

@@ -0,0 +1 @@
+from .output cimport *

python/epaswmm/output/CMakeLists.txt

@@ -1,4 +1,4 @@
-from .output import (
+from ._output import (
     UnitSystem,
     FlowUnits,
     ConcentrationUnits,

python/epaswmm/output/__init__.pxd

@@ -13,10 +13,11 @@ from libc.stdlib cimport free, malloc
 # external imports
 
 # local python and cython imports
-cimport epaswmm.epaswmm as cepaswmm
-cimport epaswmm.output.output as coutput
+from ..solver import (
+    decode_swmm_datetime,
+)
 
-from epaswmm.output.output cimport (
+from .output cimport (
     SMO_unitSystem,
     SMO_flowUnits, 
     SMO_concUnits, 
@@ -26,6 +27,9 @@ from epaswmm.output.output cimport (
     SMO_nodeAttribute, 
     SMO_linkAttribute, 
     SMO_systemAttribute,
+    SMO_Handle,
+    MAXFILENAME,
+    MAXELENAME,
     SMO_init,
     SMO_open,
     SMO_close,
@@ -302,7 +306,7 @@ cdef class Output:
     :cvar _num_periods: Number of reporting periods.
     :cvar _times: Times of the simulation in the SWMM output file.
     """
-    cdef coutput.SMO_Handle _output_file_handle
+    cdef SMO_Handle _output_file_handle
     cdef int _version
     cdef int* _units
     cdef int _units_length
@@ -568,7 +572,7 @@ cdef class Output:
         error_code = SMO_getStartDate(self._output_file_handle, &swmm_datetime)
         self.__validate_error_code(error_code)
 
-        return cepaswmm.decode_swmm_datetime(swmm_datetime)
+        return decode_swmm_datetime(swmm_datetime)
 
     @property
     def times(self) -> List[datetime]:

python/epaswmm/output/__init__.py

@@ -4,30 +4,24 @@
 # Created on: 2024-11-19
 #
 
-# Find Python
-find_package(Python3 REQUIRED COMPONENTS Development)
-
-# Find Python extensions
-find_package(PythonExtensions REQUIRED)
-
 # Add Cython target
-add_cython_target(solver solver.pyx CXX PY3)
+add_cython_target(_solver _solver.pyx CXX PY3)
 
 # Add library
-add_library(solver MODULE ${solver})
+add_library(_solver MODULE ${_solver})
 
 # Link to SWMM and Python libraries
-target_link_libraries(solver swmm5 Python3::Python)
+target_link_libraries(_solver swmm5 Python3::Python)
 
 # Specify that this is a Python extension module
-python_extension_module(solver)
+python_extension_module(_solver)
 
 # Install the target
-install(TARGETS solver LIBRARY DESTINATION epaswmm/solver)
+install(TARGETS _solver LIBRARY DESTINATION epaswmm/solver)
 
 # Include directories
 target_include_directories(
-    solver PUBLIC
+    _solver PUBLIC
     ${CMAKE_CURRENT_SOURCE_DIR}
     $<TARGET_PROPERTY:swmm5,INCLUDE_DIRECTORIES>
     ${Python3_INCLUDE_DIRS}

python/epaswmm/output/output.pyi python/epaswmm/output/_output.pyi

@@ -0,0 +1 @@
+from .solver cimport *

python/epaswmm/output/output.pyx python/epaswmm/output/_output.pyx

@@ -2,7 +2,7 @@
 # Created by: Caleb Buahin (EPA/ORD/CESER/WID)
 # Created on: 2024-11-19
 
-from .solver import (
+from ._solver import (
     SWMMObjects,
     SWMMNodeTypes,
     SWMMRainGageProperties,

python/epaswmm/solver/CMakeLists.txt

@@ -575,6 +575,16 @@ class Solver:
     """
     A class to represent a SWMM solver.
     """
+    def __init__(self, inp_file: str, rpt_file: str = ..., out_file: str = ...) -> None:
+        """
+        Constructor to initialize the solver.
+
+        :param inp_file: Input file name
+        :param rpt_file: Report file name
+        :param out_file: Output file name
+        """
+        ...
+        
     def __enter__(self): # -> Self@Solver:
         """
         Enter method for context manager.