optivgi 0.1.0__tar.gz

optivgi-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

optivgi-0.1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: optivgi
+Version: 0.1.0
+Summary: An EV smart charging management application designed to optimize electric vehicle charging based on power or pricing constraints.
+Author-email: Nithin Manne <nmanne@anl.gov>, Jason Harper <jharper@anl.gov>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/nmanne-anlgov/Opti-VGI
+Project-URL: Issues, https://github.com/nmanne-anlgov/Opti-VGI/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pulp
+Dynamic: license-file
+
+# Argonne Opti-VGI
+
+### Opti-VGI: EV Smart Charging Scheduler Application
+
+## Description
+
+Opti-VGI is an EV smart charging management application designed to optimize electric vehicle charging based on power or pricing constraints. This application can integrate with any OCPP 2.X CSMS to accomplish ISO 15118 charge scheduling
+
+
+## Proposed System Architecture
+
+### Translation Layer
+- An application that interfaces between the Charge Station Management System (CSMS) and the Charge Scheduling Management Algorithm (CSM)
+
+### Modular Charge Scheduling Management (SCM) Application
+- A modular framework that allows using different algorithms

optivgi-0.1.0/README.md

@@ -0,0 +1,16 @@
+# Argonne Opti-VGI
+
+### Opti-VGI: EV Smart Charging Scheduler Application
+
+## Description
+
+Opti-VGI is an EV smart charging management application designed to optimize electric vehicle charging based on power or pricing constraints. This application can integrate with any OCPP 2.X CSMS to accomplish ISO 15118 charge scheduling
+
+
+## Proposed System Architecture
+
+### Translation Layer
+- An application that interfaces between the Charge Station Management System (CSMS) and the Charge Scheduling Management Algorithm (CSM)
+
+### Modular Charge Scheduling Management (SCM) Application
+- A modular framework that allows using different algorithms

optivgi-0.1.0/optivgi/scm/algorithm.py

@@ -0,0 +1,31 @@
+from abc import ABC, abstractmethod
+from datetime import datetime
+from typing import Optional
+
+from .ev import EV, ChargingRateUnit
+from .constants import AlgorithmConstants
+
+class Algorithm(ABC):
+    """Abstract class for SCM Algorithms"""
+    def __init__(self, evs: list[EV], peak_power_demand: list[float], now: datetime):
+        self.evs = evs
+        self.peak_power_demand = peak_power_demand
+        self.now = now
+
+        assert len(self.peak_power_demand) == AlgorithmConstants.TIMESTEPS, f'Peak power demand must be the same length as the number of timesteps ({AlgorithmConstants.TIMESTEPS})'
+
+    @abstractmethod
+    def calculate(self) -> None:
+        """Run the algorithm to calculate the power for each EV"""
+
+    def get_current_power(self, unit: Optional[ChargingRateUnit] = None) -> dict[EV, dict]:
+        """Helper function to get the current time charging profiles for each EV"""
+        return {ev: ev.current_charging_profile(self.now, unit) for ev in self.evs}
+
+    def get_charging_profiles(self, unit: Optional[ChargingRateUnit] = None) -> dict[EV, dict]:
+        """Helper function to get the full charging profiles for each EV"""
+        return {ev: ev.charging_profile(self.now, unit) for ev in self.evs}
+
+    def get_total_energy_charged(self) -> dict[EV, float]:
+        """Helper function to get the total energy charged for each EV"""
+        return {ev: ev.energy_charged() for ev in self.evs}

optivgi-0.1.0/optivgi/scm/constants.py

@@ -0,0 +1,22 @@
+from datetime import timedelta
+
+
+class AlgorithmConstants:
+    """Constants for the SCM algorithm"""
+    RESOLUTION = timedelta(minutes=1)
+
+    RUNTIME = timedelta(hours=8)
+
+    TIMESTEPS = int(RUNTIME.total_seconds() / RESOLUTION.total_seconds())
+
+    POWER_ENERGY_FACTOR = RESOLUTION.total_seconds() / timedelta(hours=1).total_seconds()
+
+
+class EVConstants:
+    """Constants for the EV"""
+    CHARGING_PROFILE_ID = 1
+    CHARGING_PROFILE_PURPOSE = 'TxProfile'
+    CHARGING_PROFILE_STACK_LEVEL = 1
+    CHARGING_PROFILE_KIND = 'Absolute'
+
+    CHARGING_RATE_VOLTAGE = 240

optivgi-0.1.0/optivgi/scm/ev.py

@@ -0,0 +1,118 @@
+from dataclasses import dataclass, field
+from enum import Enum
+from datetime import datetime
+from typing import Optional, Self
+
+from .constants import EVConstants, AlgorithmConstants
+
+
+
+class ChargingRateUnit(Enum):
+    '''Enum for Charging Rate Unit'''
+    W = 'W'
+    A = 'A'
+
+    def convert(self, value: float, unit: Self, voltage: Optional[float] = None) -> float:
+        '''Convert the power in kW/A to the correct unit'''
+        match unit:
+            case ChargingRateUnit.W:
+                power_w = value * 1000
+            case ChargingRateUnit.A:
+                power_w = value * voltage if voltage else EVConstants.CHARGING_RATE_VOLTAGE
+
+        if self == ChargingRateUnit.A:
+            return power_w / voltage if voltage else EVConstants.CHARGING_RATE_VOLTAGE
+
+        return power_w
+
+@dataclass
+class EV:
+    """Class for Storing EV attributes"""
+    ev_id: int
+    active: bool
+    station_id: int
+    connector_id: int
+    min_power: float # kW / A
+    max_power: float # kW / A
+
+    arrival_time: datetime
+    departure_time: datetime
+    energy: float # kWh / Ah
+
+    unit: ChargingRateUnit = ChargingRateUnit.W
+    voltage: float = EVConstants.CHARGING_RATE_VOLTAGE
+
+    power: list[float] = field(default_factory=lambda: [0.] * AlgorithmConstants.TIMESTEPS, repr=False)
+
+    def __eq__(self, other):
+        if not isinstance(other, EV):
+            return NotImplemented
+        return self.ev_id == other.ev_id
+
+    def __hash__(self):
+        return hash(self.ev_id)
+
+    def departure_index(self, now: datetime) -> int:
+        """Get the index of the departure time based on the current time"""
+        departure_index = int((self.departure_time - now).total_seconds() / AlgorithmConstants.RESOLUTION.total_seconds())
+        return max(0, min(departure_index, AlgorithmConstants.TIMESTEPS - 1))
+
+    def arrival_index(self, now: datetime) -> int:
+        """Get the index of the arrival time based on the current time"""
+        arrival_index = int((self.arrival_time - now).total_seconds() / AlgorithmConstants.RESOLUTION.total_seconds())
+        return max(0, min(arrival_index, AlgorithmConstants.TIMESTEPS - 1))
+
+    def energy_charged(self) -> float:
+        """Get the total energy charged by the EV"""
+        return sum(self.power) * AlgorithmConstants.POWER_ENERGY_FACTOR
+
+    def current_charging_profile(self, now: datetime, unit: Optional[ChargingRateUnit] = None) -> dict:
+        """Get the current time charging profile for the EV"""
+        if unit is None:
+            unit = self.unit
+        return {
+            "chargingProfileId": EVConstants.CHARGING_PROFILE_ID,
+            "stackLevel": EVConstants.CHARGING_PROFILE_STACK_LEVEL,
+            "chargingProfilePurpose": EVConstants.CHARGING_PROFILE_PURPOSE,
+            "chargingProfileKind": EVConstants.CHARGING_PROFILE_KIND,
+            "chargingSchedule": {
+                "startSchedule": now.strftime('%Y-%m-%dT%H:%M:%SZ'),
+                "chargingRateUnit": unit.value,
+                "chargingSchedulePeriod":[{
+                    "startPeriod": 0,
+                    "limit": unit.convert(self.power[0], self.unit, self.voltage),
+                    "numberPhases": 1
+                }]
+            }
+        }
+
+    def charging_profile(self, now: datetime, unit: Optional[ChargingRateUnit] = None) -> dict:
+        """Get the full charging profile for the EV"""
+        if unit is None:
+            unit = self.unit
+
+        charging_schedule_period = [
+            {
+                "startPeriod": i * AlgorithmConstants.RESOLUTION.total_seconds(),
+                "limit": unit.convert(power, self.unit, self.voltage),
+                "numberPhases": 1
+            }
+            for i, power in enumerate(self.power)
+        ]
+
+        charging_schedule_period_compressed = [charging_schedule_period[0]]
+        for period in charging_schedule_period[1:]:
+            if period['limit'] != charging_schedule_period_compressed[-1]['limit']:
+                charging_schedule_period_compressed.append(period)
+
+        return {
+            "chargingProfileId": EVConstants.CHARGING_PROFILE_ID,
+            "stackLevel": EVConstants.CHARGING_PROFILE_STACK_LEVEL,
+            "chargingProfilePurpose": EVConstants.CHARGING_PROFILE_PURPOSE,
+            "chargingProfileKind": EVConstants.CHARGING_PROFILE_KIND,
+            "chargingSchedule": {
+                "startSchedule": now.strftime('%Y-%m-%dT%H:%M:%SZ'),
+                "chargingRateUnit": unit.value,
+                "chargingSchedulePeriod": charging_schedule_period_compressed
+            }
+        }

optivgi-0.1.0/optivgi/scm/go_algorithm.py

@@ -0,0 +1,154 @@
+# pylint: disable=missing-function-docstring
+import math
+import logging
+from dataclasses import dataclass, field
+
+from .algorithm import Algorithm
+from .constants import AlgorithmConstants
+from .ev import EV
+
+
+# Debug Flag
+DEBUG = False
+
+# Configuration
+FAIRNESS_FACTOR = 1.
+SHIFT_FRONT = True
+ALLOC_REMAINING_EXTRA = True
+
+
+class GoAlgorithm(Algorithm):
+    """SCM Algorithm created for use with the GO EV Scheduler"""
+
+    @dataclass
+    class EVPower:
+        """Class for allocating EV power"""
+        ev: EV
+        energy_left: float = field(init=False)
+
+        def __post_init__(self):
+            self.energy_left = self.ev.energy
+
+        def power(self, time: int, max_available=float('inf'), ignore_energy=False):
+            return max(
+                self.ev.min_power - self.ev.power[time],
+                min(self.ev.max_power - self.ev.power[time],
+                    self.energy_left / AlgorithmConstants.POWER_ENERGY_FACTOR if not ignore_energy else float('inf'),
+                    max_available))
+
+        def accept_power(self, time: int, power: float, ignore_energy=False):
+            try:
+                assert power <= self.power(time, ignore_energy=ignore_energy)
+            except AssertionError as e:
+                logging.error('Assertion Error: %s', e.args[0] if e.args else repr(e))
+                logging.error('EV: %s', self.ev)
+                logging.error('Time: %s', time)
+                logging.error('Power: %s', power)
+                logging.error('Energy Left: %s', self.energy_left)
+                logging.error('Power at Time: %s', self.ev.power[time])
+            if DEBUG:
+                logging.info('%s accepted %s at %s', self.ev.ev_id, power, time)
+            self.energy_left -= power * AlgorithmConstants.POWER_ENERGY_FACTOR
+            self.ev.power[time] += power
+
+        def shift_power(self, time_from: int, time_to: int, power: float):
+            if time_from == time_to:
+                return
+            try:
+                assert power <= self.ev.power[time_from]
+                assert power <= self.ev.max_power - self.ev.power[time_to]
+            except AssertionError as e:
+                logging.error('Assertion Error: %s', e.args[0] if e.args else repr(e))
+                logging.error('EV: %s', self.ev)
+                logging.error('Time From: %s', time_from)
+                logging.error('Time To: %s', time_to)
+                logging.error('Power: %s', power)
+                logging.error('Energy Left: %s', self.energy_left)
+                logging.error('Power at Time From: %s', self.ev.power[time_from])
+                logging.error('Power at Time To: %s', self.ev.power[time_to])
+            if DEBUG:
+                logging.info('%s shifted {p} from %s to %s', self.ev.ev_id, time_from, time_to)
+            self.ev.power[time_from] -= power
+            self.ev.power[time_to] += power
+
+    def calculate(self) -> None:
+        evs = {ev.ev_id: self.EVPower(ev=ev) for ev in self.evs}
+
+        evs_present: list[set[int]] = [set() for _ in range(AlgorithmConstants.TIMESTEPS)]
+        for ev_id, ev in evs.items():
+            for time_index in range(ev.ev.arrival_index(self.now), ev.ev.departure_index(self.now)):
+                evs_present[time_index].add(ev_id)
+
+        available_peak_power = self.peak_power_demand.copy()
+        for time in range(AlgorithmConstants.TIMESTEPS - 1, -1, -1):
+            # Allocate Minimum Power first
+            for ev_id in evs_present[time]:
+                ev = evs[ev_id]
+                ev.accept_power(time, ev.ev.min_power)
+                available_peak_power[time] -= ev.ev.min_power
+
+            while available_peak_power[time] > 0:
+                evs_to_allocate = [(ev_id, evs[ev_id].power(time))
+                                   for ev_id in evs_present[time]
+                                   if evs[ev_id].power(time) != 0]
+                if not evs_to_allocate:
+                    break
+
+                total_power_required = sum(p**FAIRNESS_FACTOR for _, p in evs_to_allocate)
+                power_allocation = [(ev_id, power**FAIRNESS_FACTOR / total_power_required * available_peak_power[time])
+                                    for ev_id, power in evs_to_allocate]
+                if sum(allocated_power for _, allocated_power in power_allocation) == 0:
+                    break
+
+                if DEBUG:
+                    logging.info('Splitting %s -> %s into %s', time, available_peak_power[time], power_allocation)
+                for ev_id, allocated_power in power_allocation:
+                    ev = evs[ev_id]
+                    power = ev.power(time, allocated_power)
+                    ev.accept_power(time, power)
+                    available_peak_power[time] -= power
+
+        if SHIFT_FRONT:
+            for time_from in range(AlgorithmConstants.TIMESTEPS - 1, -1, -1):
+                for ev_id, ev in evs.items():
+                    time_to = time_from - 1
+                    while time_to >= 0 and ev.ev.power[time_from] > ev.ev.min_power and ev_id in evs_present[time_to] and available_peak_power[time_to] > 0:
+                        power = min(available_peak_power[time_to], ev.ev.power[time_from] - ev.ev.min_power, ev.ev.max_power - ev.ev.power[time_to])
+                        ev.shift_power(time_from, time_to, power)
+                        available_peak_power[time_to] -= power
+                        available_peak_power[time_from] += power
+                        time_to -= 1
+
+        if ALLOC_REMAINING_EXTRA:
+            for time in range(AlgorithmConstants.TIMESTEPS):
+                available_extra_power = available_peak_power[time]
+
+                evs_to_allocate = [(ev_id, evs[ev_id].power(time, available_extra_power, True))
+                                   for ev_id in evs_present[time]
+                                   if evs[ev_id].power(time, available_extra_power, True) != 0]
+
+                total_power_required = sum(p**FAIRNESS_FACTOR for _, p in evs_to_allocate)
+                power_allocation = [(ev_id, power**FAIRNESS_FACTOR / total_power_required * available_extra_power)
+                                    for ev_id, power in evs_to_allocate]
+                if sum(allocated_power for _, allocated_power in power_allocation) == 0:
+                    continue
+
+                for ev_id, allocation in power_allocation:
+                    ev = evs[ev_id]
+                    power = ev.power(time, allocation, True)
+                    ev.accept_power(time, power, True)
+                    available_peak_power[time] -= power
+
+        try:
+            for ev in evs.values():
+                assert all(y == 0. or y <= ev.ev.max_power or math.isclose(y, ev.ev.max_power) for y in ev.ev.power), 'EV Max Power'
+                assert all(y == 0. or y >= ev.ev.min_power for y in ev.ev.power), 'EV Min Power'
+            for i in range(AlgorithmConstants.TIMESTEPS):
+                assert available_peak_power[i] >= -1, f'{available_peak_power[i]} not greater than or equal to zero'
+                y_pm_i = sum(ev.ev.power[i] for ev in evs.values())
+                assert self.peak_power_demand[i] >= y_pm_i or math.isclose(self.peak_power_demand[i], y_pm_i), 'Total Power'
+        except AssertionError as e:
+            logging.error('Assertion Error: %s', e.args[0] if e.args else repr(e))
+            logging.error('EVs: %s', self.evs)
+            logging.error('peak_power_demand: %s', self.peak_power_demand)
+            logging.error('available_peak_power: %s', available_peak_power)

optivgi-0.1.0/optivgi/scm/pulp_numerical_algorithm.py

@@ -0,0 +1,85 @@
+import logging
+
+from pulp import LpVariable, LpProblem, LpMaximize, PULP_CBC_CMD
+
+from .algorithm import Algorithm
+from .constants import AlgorithmConstants
+
+class PulpNumericalAlgorithm(Algorithm):
+    """Pulp Numerical SCM Algorithm"""
+
+    def calculate(self) -> None:
+        logging.info('Number of Connected EVs: %s', len(self.evs))
+
+        # Create a linear programming problem
+        model = LpProblem(name='charging_schedule', sense=LpMaximize)
+
+        # Decision variables
+        ev_vars = {
+            (ev.ev_id, time): LpVariable(name=f'X_{ev.ev_id}_{time}', lowBound=0)
+            for ev in self.evs
+            for time in range(AlgorithmConstants.TIMESTEPS)
+        }
+        ev_vars_diff = {
+            (ev.ev_id, time): LpVariable(name=f'X_diff_{ev.ev_id}_{time}', lowBound=0)
+            for ev in self.evs
+            for time in range(AlgorithmConstants.TIMESTEPS - 1)
+        }
+        percentage = LpVariable(name='percentage_charge', lowBound=0)
+
+        ev_max_demand = sum(ev.max_power for ev in self.evs) if self.evs else float('inf')
+        max_power_demand = [min(ev_max_demand, self.peak_power_demand[time]) for time in range(AlgorithmConstants.TIMESTEPS)]
+
+        # Objective function - maximize the percentage of energy charged and peak power utilization and minimize the change in power
+        model += percentage * 100 * AlgorithmConstants.TIMESTEPS * len(self.evs) + sum(
+            sum(ev_vars[ev.ev_id, time] for ev in self.evs) / max_power_demand[time] # type: ignore
+            for time in range(AlgorithmConstants.TIMESTEPS)
+        ) - sum(sum(ev_vars_diff[ev.ev_id, time] for time in range(AlgorithmConstants.TIMESTEPS - 1)) for ev in self.evs) # type: ignore
+
+        # Constraints
+        for ev in self.evs:
+            # Power Difference Constraints - absolute value
+            for time in range(AlgorithmConstants.TIMESTEPS - 1):
+                model += ev_vars_diff[ev.ev_id, time] >= ev_vars[ev.ev_id, time + 1] - ev_vars[ev.ev_id, time]
+                model += ev_vars_diff[ev.ev_id, time] >= -ev_vars[ev.ev_id, time + 1] + ev_vars[ev.ev_id, time]
+
+            # Percentage of energy charged >= maximised percentage
+            model += (
+                (sum(ev_vars[ev.ev_id, time] for time in range(AlgorithmConstants.TIMESTEPS)) * AlgorithmConstants.POWER_ENERGY_FACTOR) / ev.energy
+            ) >= percentage
+
+            # Calculate the index of the arrival and departure times
+            arrival_index = ev.arrival_index(self.now)
+            departure_index = ev.departure_index(self.now)
+
+            # Power constraints after arrival before departure
+            for time in range(arrival_index, departure_index):
+                model += ev_vars[ev.ev_id, time] >= ev.min_power
+
+                model += ev_vars[ev.ev_id, time] <= ev.max_power
+
+            # No charging before arrival
+            for time in range(arrival_index):
+                model += ev_vars[ev.ev_id, time] == 0
+
+            # No charging after departure
+            for time in range(departure_index, AlgorithmConstants.TIMESTEPS):
+                model += ev_vars[ev.ev_id, time] == 0
+
+        # Peak power demand constraint
+        for time in range(AlgorithmConstants.TIMESTEPS):
+            model += sum(ev_vars[ev.ev_id, time] for ev in self.evs) <= self.peak_power_demand[time]
+
+
+        # Solve the problem
+        model.solve(PULP_CBC_CMD(msg=False))
+
+        # Total percentage of requested energy charged
+        total_percentage = model.objective.value()
+        logging.info('Maximized Percentage of Charging: %s', total_percentage)
+
+        for ev in self.evs:
+            for time in range(AlgorithmConstants.TIMESTEPS):
+                ev.power[time] = ev_vars[ev.ev_id, time].varValue # type: ignore
+
+            logging.info('EV %s: Max Power: %s / %s, Energy Charged: %s / %s', ev.ev_id, max(ev.power), ev.max_power, ev.energy_charged(), ev.energy)

optivgi-0.1.0/optivgi/scm_runner.py

@@ -0,0 +1,28 @@
+import os
+import logging
+from typing import Type
+from datetime import datetime, UTC
+
+from .translation import Translation
+from .scm.algorithm import Algorithm
+from .scm.constants import AlgorithmConstants
+from .utils import round_down_datetime
+
+def scm_runner(translation: Translation, algorithm_cls: Type[Algorithm]):
+    """Main OptiVGI function that uses the translation and algorithm to run the SCM logic"""
+    groups = filter(bool, map(str.strip, os.getenv('STATION_GROUPS', '').split(',')))
+
+    now = round_down_datetime(datetime.now(UTC), int(AlgorithmConstants.RESOLUTION.total_seconds() / 60))
+
+    logging.info('Running SCM for groups: %s at time: %s', os.getenv('STATION_GROUPS'), now)
+
+    for group in groups:
+        logging.info('Running SCM for group: %s', group)
+        evs, voltage = translation.get_evs(group)
+        peak_power_demand = translation.get_peak_power_demand(group, now, voltage)
+
+        algorithm = algorithm_cls(evs, peak_power_demand, now)
+        algorithm.calculate()
+
+        powers = algorithm.get_charging_profiles()
+        translation.send_power_to_evs(powers)

optivgi-0.1.0/optivgi/threads.py

@@ -0,0 +1,36 @@
+import time
+import logging
+import traceback
+from queue import Queue
+from datetime import datetime
+from typing import Type
+
+from .scm_runner import scm_runner
+from .translation import Translation
+from .scm.algorithm import Algorithm
+
+
+def timer_thread_worker(event_queue: Queue):
+    """Thread that sends a timer event every minute"""
+    while True:
+        current_time = time.time()
+        delay = 60 - (current_time % 60)
+        time.sleep(delay) # Sleep until the top of the next minute
+        event_queue.put("Timer Event")
+
+
+# SCM worker thread function
+def scm_worker(event_queue: Queue, translation_cls: Type[Translation], algorithm_cls: Type[Algorithm]):
+    """Thread that processes events from the event queue and runs the SCM worker"""
+    with translation_cls() as translation:
+        while True:
+            event = event_queue.get()
+            if event is None:
+                break  # Allows the thread to be stopped.
+            logging.info("Processing event %s at %s", event, datetime.now())
+            try:
+                scm_runner(translation, algorithm_cls)
+            except Exception as e: # pylint: disable=broad-except
+                logging.error("Error processing event %s: %s", event, repr(e))
+                logging.error(traceback.format_exc())
+            event_queue.task_done()

optivgi-0.1.0/optivgi/translation.py

@@ -0,0 +1,25 @@
+from abc import abstractmethod
+from contextlib import AbstractContextManager
+from datetime import datetime
+from typing import Optional
+
+from .scm.ev import EV, ChargingRateUnit
+
+class Translation(AbstractContextManager):
+    """
+    Translation Layer Abstract Class
+    This class is used to define the interface for the translation layer.
+    The translation layer is used to interact with the external EV Management System (CSMS).
+    The abstract methods defined in this class must be implemented by the concrete translation layer.
+    """
+    @abstractmethod
+    def get_peak_power_demand(self, group_name: str, now: datetime, voltage: Optional[float] = None) -> list[float]:
+        """Get the peak power demand of a group"""
+
+    @abstractmethod
+    def get_evs(self, group_name: str) -> tuple[list[EV], Optional[float]]:
+        """Get all EVs in a group and optional voltage if available"""
+
+    @abstractmethod
+    def send_power_to_evs(self, powers: dict[EV, dict], unit: Optional[ChargingRateUnit] = None):
+        """Send power to EVs"""

optivgi-0.1.0/optivgi/utils.py

@@ -0,0 +1,5 @@
+from datetime import datetime, timedelta
+
+def round_down_datetime(dt: datetime, minute: int) -> datetime:
+    """Round a timedelta to the nearest minute"""
+    return dt - timedelta(minutes=dt.minute % minute, seconds=dt.second, microseconds=dt.microsecond)

optivgi-0.1.0/optivgi.egg-info/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: optivgi
+Version: 0.1.0
+Summary: An EV smart charging management application designed to optimize electric vehicle charging based on power or pricing constraints.
+Author-email: Nithin Manne <nmanne@anl.gov>, Jason Harper <jharper@anl.gov>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/nmanne-anlgov/Opti-VGI
+Project-URL: Issues, https://github.com/nmanne-anlgov/Opti-VGI/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pulp
+Dynamic: license-file
+
+# Argonne Opti-VGI
+
+### Opti-VGI: EV Smart Charging Scheduler Application
+
+## Description
+
+Opti-VGI is an EV smart charging management application designed to optimize electric vehicle charging based on power or pricing constraints. This application can integrate with any OCPP 2.X CSMS to accomplish ISO 15118 charge scheduling
+
+
+## Proposed System Architecture
+
+### Translation Layer
+- An application that interfaces between the Charge Station Management System (CSMS) and the Charge Scheduling Management Algorithm (CSM)
+
+### Modular Charge Scheduling Management (SCM) Application
+- A modular framework that allows using different algorithms

optivgi-0.1.0/optivgi.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+optivgi/__init__.py
+optivgi/scm_runner.py
+optivgi/threads.py
+optivgi/translation.py
+optivgi/utils.py
+optivgi.egg-info/PKG-INFO
+optivgi.egg-info/SOURCES.txt
+optivgi.egg-info/dependency_links.txt
+optivgi.egg-info/requires.txt
+optivgi.egg-info/top_level.txt
+optivgi/scm/algorithm.py
+optivgi/scm/constants.py
+optivgi/scm/ev.py
+optivgi/scm/go_algorithm.py
+optivgi/scm/pulp_numerical_algorithm.py

optivgi-0.1.0/optivgi.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

optivgi-0.1.0/optivgi.egg-info/requires.txt

@@ -0,0 +1 @@
+pulp

optivgi-0.1.0/optivgi.egg-info/top_level.txt

@@ -0,0 +1 @@
+optivgi

optivgi-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=70.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "optivgi"
+version = "0.1.0"
+authors = [
+  { name="Nithin Manne", email="nmanne@anl.gov" },
+  { name="Jason Harper", email="jharper@anl.gov" },
+]
+description = "An EV smart charging management application designed to optimize electric vehicle charging based on power or pricing constraints."
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+]
+dynamic = ["dependencies"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies = { dev = { file = ["dev-requirements.txt"] }}
+
+[project.urls]
+Homepage = "https://github.com/nmanne-anlgov/Opti-VGI"
+Issues = "https://github.com/nmanne-anlgov/Opti-VGI/issues"

optivgi-0.1.0/requirements.txt

@@ -0,0 +1 @@
+pulp

optivgi-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+