Merge pull request #29 from abhishekvraman/maha_dev

Added Classes for Measurement. Updated Series as a seprate module.

.github/workflows/build-windows.yml

@@ -35,7 +35,7 @@ jobs:
         git clone https://github.com/abhishekvraman/Propylean.git
         cd Propylean
         python -m build
-        python -m pip install dist/propylean-0.2.5-py3-none-any.whl
+        python -m pip install dist/propylean-0.2.6-py3-none-any.whl
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2023, 2022, 2021 Abhishek Venkitta Raman
+Copyright (c)2024, 2023, 2022, 2021 Abhishek Venkitta Raman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Models/pump_circuit.ipynb

@@ -1,6 +1,7 @@
 {
  "cells": [
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "c98d186c",
    "metadata": {},
@@ -32,12 +33,12 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Material Stream Tag: Water 0\n",
-      "Material Stream Tag: Water 1\n",
-      "Material Stream Tag: Water 2\n",
-      "Material Stream Tag: Water 3\n",
-      "Material Stream Tag: Water 4\n",
-      "Material Stream Tag: Water 5\n"
+      "Material Stream with tag: Water 0\n",
+      "Material Stream with tag: Water 1\n",
+      "Material Stream with tag: Water 2\n",
+      "Material Stream with tag: Water 3\n",
+      "Material Stream with tag: Water 4\n",
+      "Material Stream with tag: Water 5\n"
      ]
     }
    ],
@@ -118,6 +119,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "098cf610",
    "metadata": {},
@@ -150,6 +152,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "01428f74",
    "metadata": {},
@@ -180,6 +183,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "6223f571",
    "metadata": {},
@@ -264,6 +268,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "6e55a763",
    "metadata": {},
@@ -294,6 +299,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "a2f94a64",
    "metadata": {},
@@ -346,6 +352,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "68626db0",
    "metadata": {},
@@ -376,6 +383,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "cbcc786e",
    "metadata": {},
@@ -434,6 +442,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "080702ed",
    "metadata": {},
@@ -464,6 +473,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "eedc8eb9",
    "metadata": {},
@@ -514,6 +524,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "id": "242284cc",
    "metadata": {},
@@ -553,7 +564,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "C:\\Users\\VijayaShree\\Documents\\Abhishek\\Propylean\\src\\propylean\\properties.py:87: UserWarning: Time series of the property is not set. Series attribute is considerd using 'value', 'max_val', or 'min_val' if provided.\n",
+      "C:\\Users\\AVRaman\\Documents\\Codes\\Propylean\\src\\propylean\\properties.py:89: UserWarning: Time series of the property is not set. Series attribute is considerd using 'value', 'max_val', or 'min_val' if provided.\n",
       "  warn(\"Time series of the property is not set. Series attribute is considerd using 'value', 'max_val', or 'min_val' if provided.\")\n"
      ]
     },
@@ -575,7 +586,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -589,7 +600,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.1"
+   "version": "3.10.0"
   },
   "vscode": {
    "interpreter": {

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = propylean
-version = 0.2.5
+version = 0.2.6
 author = Abhishek V Raman
 author_email = 
 description = The open-source calculations and analytics package for chemical process industries.

src/propylean/equipments/abstract_equipment_classes.py

@@ -24,16 +24,8 @@ def __init__(self, **inputs) -> None:
                 Type: str
                 Acceptable values: Any string type
                 Default value: None
-                Description: Equipment tag the user wants to provide. If not provided, then tag is automatically generated
-            
-            dynamic_state:
-                Required: No
-                Type: bool
-                Acceptable values: True or False
-                Default value: False
-                Description: If equipment is in dynamic state and inventory is changing.
-                             TODO: Provide dynamic simulation capabilities.
-            
+                Description: Equipment tag the user wants to provide. If not provided, then tag is automatically generated.
+
             pressure_drop:
                 Required: No
                 Type: int or float (recommended)
@@ -54,15 +46,12 @@ def __init__(self, **inputs) -> None:
             >>> class NewEquipment(_EquipmentOneInletOutlet):
                 ......
         """
-        if 'tag' not in inputs:
-            self.tag = self._create_equipment_tag()  
-        else:
-            self.tag = inputs['tag']
-        self.dynamic_state = False if 'dynamic_state' not in inputs else False
+        self.tag = inputs.pop('tag', self._create_equipment_tag())
 
         #Flow properties
         self._inlet_mass_flowrate = prop.MassFlowRate() 
         self._outlet_mass_flowrate = prop.MassFlowRate()
+        self._inventory_change_rate = prop.MassFlowRate()
         self.design_flowrate = prop.MassFlowRate()
 
         #Pressure properties
@@ -280,13 +269,10 @@ def outlet_mass_flowrate(self, value):
     @property
     def inventory_change_rate(self):
         self = self._get_equipment_object(self)
-        if not self.dynamic_state:
-            return prop.MassFlowRate(0, self.inlet_mass_flowrate.unit)            
-        return self._inlet_mass_flowrate - self._outlet_mass_flowrate                             
+        return self._inventory_change_rate
     @inventory_change_rate.setter
     def inventory_change_rate(self, value):
-        raise Exception("Dynamic process is not yet supported.")
-        _Validators.validate_arg_prop_value_type("inventory_change_rate", value, (int))
+        _Validators.validate_arg_prop_value_type("inventory_change_rate", value, (int, float, prop.MassFlowRate))
         self = self._get_equipment_object(self)
         value, unit = self._tuple_property_value_unit_returner(value, prop.MassFlowRate)
         if unit is None: