Daripa-Research-Group · bhargavakula01 · Apr 5, 2026 · Mar 5, 2026 · Mar 6, 2026 · Mar 8, 2026
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./lib.html"/>
+</head>
+</html>
diff --git a/docs/lib.html b/docs/lib.html
diff --git a/docs/lib/Exceptions.html b/docs/lib/Exceptions.html
diff --git a/docs/lib/enumerations.html b/docs/lib/enumerations.html
diff --git a/docs/lib/grid.html b/docs/lib/grid.html
diff --git a/docs/lib/polymer.html b/docs/lib/polymer.html
diff --git a/docs/lib/simulation.html b/docs/lib/simulation.html
diff --git a/docs/lib/surfactant.html b/docs/lib/surfactant.html
diff --git a/docs/lib/test.html b/docs/lib/test.html
diff --git a/docs/lib/water.html b/docs/lib/water.html
diff --git a/docs/search.js b/docs/search.js
diff --git a/lib/Exceptions.py b/lib/Exceptions.py
@@ -2,16 +2,23 @@ class OutOfRangeError(Exception):
     """Exception raised for errors in the input if it is out of range."""
 
     def __init__(self, value, message="Value is out of the allowed range."):
-        self.value = value
-        self.message = message
+        """
+        Args:
+        -----
+            value (float): value that the user provided in GUI
+            message (str): Error message
+        """
+        self._value = value
+        self._message = message
         super().__init__(self.message)
 
     def __str__(self):
         """
-        :return: Returns the error message
-        :rtype: str
+        Returns: (str)
+        --------------
+            Returns the error message
         """
-        return f"{self.value} -> {self.message}"
+        return f"{self._value} -> {self._message}"
 
 
 class SimulationCalcInputException(Exception):
@@ -22,18 +29,22 @@ class SimulationCalcInputException(Exception):
     def __init__(self, message):
         """
         constructor exception object
-
-        :param message: takes in the error message
-        :type message: str
+
+        Args:
+        -----
+            message (str): takes in the error message
         """
-        self.message = message
+        self._message = message
 
     def __str__(self):
         """
-        :return: Returns the error message
-        :rtype: str
+        Returns: (str)
+        --------------
+            Returns the error message
         """
-        return self.message
+        return self._message
+
+
 
 
 class UserInputException(Exception):
@@ -45,19 +56,19 @@ def __init__(self, message: str, inputs: dict | None = None):
         """
         Initialize the exception with a message and optional input dictionary.
 
-        :param message: Description of the validation error.
-        :type message: str
-
-        :param inputs: Dictionary of user inputs (optional).
-        :type inputs: dict, None
+        Args:
+        -----
+            message (str): Description of the validation error.
+            inputs (dict, None): Dictionary of user inputs (optional).
         """
         super().__init__(message)
-        self.message = message
-        self.user_inputs = inputs or {}
+        self._message = message
+        self._user_inputs = inputs or {}
 
     def __str__(self):
         """
-        :return: Returns the error message
-        :rtype: str
+        Returns: (str)
+        --------------
+            Returns the error message
         """
-        return f"UserInputException: {self.message}"
+        return f"UserInputException: {self._message}"
diff --git a/lib/enumerations.py b/lib/enumerations.py
@@ -62,22 +62,37 @@ class PolymerList(Enum):
 
     @property
     def Id(self):
+        """
+        Id (int): Index for Polymer
+        """
         return self.value[0]
 
     @property
     def Density(self):  # kg/m^3
+        """
+        Density (float): density of the Polymer
+        """
         return self.value[1]
 
     @property
     def n_coeff(self):  # dimensionless
+        """
+        n_coeff (list[float]): 'n' coeffient for the empirical power law equation
+        """
         return self.value[2]
 
     @property
     def e_coeff(self):  # dimensionless
+        """
+        e_coeff (list[float]): 'ε' coeffient for the empirical power law equation
+        """
         return self.value[3]
 
     @classmethod
     def get_by_value(cls, value):
+        """
+        retrieves Polymer from enumeration based on value
+        """
         member = next((member for member in cls if member.value[0] == value), None)
         return member
 
@@ -98,18 +113,30 @@ class SurfactantList(Enum):
 
     @property
     def Id(self):
+        """
+        Id (int): Index for Polymer
+        """
         return self.value[0]
 
     @property
     def IFT_equation(self):
+        """
+        IFT_equation (lambda): the relationship between surfactant concentration and interfacial tension
+        """
         return self.value[1]
 
     @property
     def derivative_IFT_equation(self):
+        """
+        derivative_IFT_equation (lambda): the derivative of the IFT_equation
+        """
         return self.value[2]
 
     @classmethod
     def get_by_value(cls, value):
+        """
+        retrieves Surfactant from enumeration based on value
+        """
         member = next((member for member in cls if member.value[0] == value), None)
         return member