Merge pull request #193 from pnnl/test-workflows

Add automated linting as a github action.

Author: d3j331

.github/workflows/lint.yml

@@ -0,0 +1,54 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Lint and test
+
+on:
+  push:
+    branches: [ "main", "develop", "test-workflows"]
+  pull_request:
+    branches: [ "main", "develop", "test-workflows"]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        pip install -e ./src/tesp_support 
+        pip install ruff pytest mypy
+
+    - name: Lint with ruff
+      run: |
+        #       Test code with ruff. This will check for syntax and runtime errors.
+        #       The values after --ignore prefixes that match all error codes starting with those characters.
+        #       F codes found at https://flake8.pycqa.org/en/latest/user/error-codes.html
+        #       F841    unused-variable
+        #       E9xx: Runtime (https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes)
+        #       E731    lambda-assignment
+        ruff check ./src --ignore=F841,E731
+        #       exit-zero treats all errors as warnings.
+        # ruff check ./src --exit-zero --statistics
+    
+    - name: Check types with mypy
+      run: |
+        #       Stop the build if there are Python syntax errors and runtime errors.
+        #       The values after --disable-error-code ignores match codes starting with those characters.
+        mypy ./src/tesp_support/tesp_support/api --disable-error-code import-untyped --disable-error-code union-attr --disable-error-code attr-defined --disable-error-code import-not-found
+
+    - name: Test with pytest
+      run: |
+        source ./tesp.env
+        pytest ./src/tesp_support/test/api  # only api tests for now

.github/workflows/pypi-publish.yml

@@ -0,0 +1,40 @@
+name: Deploy PYPI Project CI
+
+on:
+  push:
+    branches: [ "main"]
+    tags:
+      - 'v*'  # Triggers on version tags
+      
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine build
+
+      - name: Build package
+        run: |
+          cd src/tesp_support
+          python -m build .
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}  # Use your PyPI username
+          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}  # Store your token in GitHub secrets
+        #   TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD_TEST }}  # Store your token in GitHub secrets
+        run: |
+          printf "Deploying PYPI project"
+          twine upload src/tesp_support/dist/*
+        #   twine upload --repository testpypi src/tesp_support/dist/*

examples/analysis/consensus/code/post_processing/TMG_plots.py

@@ -2815,7 +2815,7 @@ def customer_comparative_analysis(case_data, comp_data, case_path, comp_path, ds
     # x = customer_diff_df.loc(axis=0)[:, ['kw-hr']]
 
     customer_diff_df.to_csv(path_or_buf=case_path + '\\customer_diff_data_DSO'+dso_num+'.csv')
-    participating = customer_diff_df.loc[customer_diff_df[('metadata','participating')] == True]
+    participating = customer_diff_df.loc[customer_diff_df[('metadata','participating')]]
 
     plt.figure()
     plt.scatter(participating[('metadata','slider_setting')], -100*participating[(month,'kw-hr')])

examples/analysis/dsot/code/run_annual_postprocessing.py

@@ -186,7 +186,7 @@ def run_annual_postprocessing(case_list: list, base_case_path: str, demand_case_
     logger.info("Run base: %s", run_base)
 
     # Process the base case first
-    if run_base == True:
+    if run_base:
         case_list.insert(0, str(base_case_path))
         logger.info("Added base case to processing list")
     else:

examples/analysis/glm_dsot/code/run_annual_postprocessing.py

@@ -82,7 +82,7 @@ def run_annual_postprocessing(case_list: list, base_case_path: str, demand_case_
     """
 
     # Process the base case first
-    if run_base == True:
+    if run_base:
         case_list.insert(0, str(base_case_path))
     else: 
         pass

examples/capabilities/ercot/bulk_system/loopERCOT.py

@@ -282,7 +282,7 @@ def make_dictionary(ppc, rootname):
     # run OPF to establish the prices and economic dispatch
     if ts >= tnext_opf:
         ropf = pp.runopf(ppc, ppopt_market)
-        if ropf['success'] == False:
+        if not ropf['success']:
             conv_accum = False
         opf_bus = deepcopy(ropf['bus'])
         opf_gen = deepcopy(ropf['gen'])
@@ -321,7 +321,7 @@ def make_dictionary(ppc, rootname):
     ppc['bus'][:, 13] = opf_bus[:, 13]  # set the lmp
     ppc['gen'][:, 1] = opf_gen[:, 1]  # set the economic dispatch
     rpf = pp.runpf(ppc, ppopt_regular)
-    if rpf[0]['success'] == False:
+    if not rpf[0]['success']:
         conv_accum = False
         print('rpf did not converge at', ts)
     #   pp.printpf (100.0,

examples/capabilities/ercot/case8/tso_most.py

@@ -910,7 +910,7 @@ def tso_most_loop_f(bTestDAM=False, test_bids=None):
                 write_most_base_case(ppc, 'rtmcase_{:d}.m'.format(ts))
             #      rBus, rBranch, rGen, rGenCost = solve_most_rtm_case(ppc['MostCommand'], 'solvertmcase.m')
             ropf = pp.runopf(ppc, ppopt_market)
-            if ropf['success'] == False:
+            if not ropf['success']:
                 ropf['bus'][:, 13] = ppc['lmp_cap']
                 conv_accum = False
             opf_bus = deepcopy(ropf['bus'])

examples/capabilities/ercot/case8/tso_psst_f.py

@@ -1314,7 +1314,7 @@ def update_cost_and_load():
 
             #    tso.print_mod_load(ppc['bus'], ppc['DSO'], gld_load, 'OPF', ts)
             ropf = pp.runopf(ppc, ppopt_market)
-            if ropf['success'] == False:
+            if not ropf['success']:
                 conv_accum = False
             opf_bus = deepcopy(ropf['bus'])
             opf_gen = deepcopy(ropf['gen'])

models/lbnl/dockers/Estimation/develop/w_energyplus/workflow.py

@@ -132,7 +132,7 @@ def param_estimation(model_param, ADD_UNIT_EP_TZONE):
     emulation.collect_measurements(estimation_start_time, estimation_stop_time)
 
     # Add units to EnergyPlus output variables
-    if ((ADD_UNIT_EP_TZONE == True) and obs_var == 'Tzone'):
+    if ((ADD_UNIT_EP_TZONE) and obs_var == 'Tzone'):
         print("==========WARNING: When using E+FMU, if the output of E+ is the "
               "zone temperature, then the next lines will add the unit degC to the "
               "output results. This is only valid for E+ and an output which is Tzone.")

models/pitt/Reduced_Order_Model/tesp_support/feederGenerator.py

@@ -1315,7 +1315,7 @@ def write_houses(basenode, op, vnom):
     else:
         vstart = format(-0.5 * vnom, '.2f') + '+' + format(0.866025 * vnom, '.2f') + 'j'
 
-    if forERCOT == True:
+    if forERCOT:
         phs = phs + 'S'
         tpxname = gld_strict_name(basenode + '_tpx')
         mtrname = gld_strict_name(basenode + '_mtr')
@@ -1328,7 +1328,7 @@ def write_houses(basenode, op, vnom):
         print('  voltage_2 ' + vstart + ';', file=op)
         print('}', file=op)
     for i in range(nhouse):
-        if forERCOT == False:
+        if not forERCOT:
             tpxname = gld_strict_name(basenode + '_tpx_' + str(i + 1))
             mtrname = gld_strict_name(basenode + '_mtr_' + str(i + 1))
             print('object triplex_line {', file=op)
@@ -1700,7 +1700,7 @@ def write_substation(op, name, phs, vnom, vll):
     if len(fncs_case) > 0:
         print('#ifdef USE_FNCS', file=op)
         print('object fncs_msg {', file=op)
-        if forERCOT == True:
+        if forERCOT:
             print('  name gridlabd' + fncs_case + ';', file=op)
         else:
             print('  name gridlabdSimulator1;', file=op)
@@ -1760,7 +1760,7 @@ def write_voltage_class(model, h, t, op, vprim, vll, secmtrnode):
                 bHaveS = True
             else:
                 bHaveS = False
-            if bHaveS == True and bHadS == False:
+            if bHaveS and not bHadS:
                 prefix = 'triplex_'
             print('object ' + prefix + t + ' {', file=op)
             if len(parent) > 0:
@@ -1776,17 +1776,17 @@ def write_voltage_class(model, h, t, op, vprim, vll, secmtrnode):
             if 'load_class' in model[t][o]:
                 print('  load_class ' + model[t][o]['load_class'] + ';', file=op)
             if 'constant_power_A' in model[t][o]:
-                if bHaveS == True:
+                if bHaveS:
                     print('  power_1 ' + model[t][o]['constant_power_A'] + ';', file=op)
                 else:
                     print('  constant_power_A ' + model[t][o]['constant_power_A'] + ';', file=op)
             if 'constant_power_B' in model[t][o]:
-                if bHaveS == True:
+                if bHaveS:
                     print('  power_1 ' + model[t][o]['constant_power_B'] + ';', file=op)
                 else:
                     print('  constant_power_B ' + model[t][o]['constant_power_B'] + ';', file=op)
             if 'constant_power_C' in model[t][o]:
-                if bHaveS == True:
+                if bHaveS:
                     print('  power_1 ' + model[t][o]['constant_power_C'] + ';', file=op)
                 else:
                     print('  constant_power_C ' + model[t][o]['constant_power_C'] + ';', file=op)
@@ -1800,19 +1800,19 @@ def write_voltage_class(model, h, t, op, vprim, vll, secmtrnode):
             vstartb = format(-0.5 * vnom, '.2f') + format(-0.866025 * vnom, '.2f') + 'j'
             vstartc = format(-0.5 * vnom, '.2f') + '+' + format(0.866025 * vnom, '.2f') + 'j'
             if 'voltage_A' in model[t][o]:
-                if bHaveS == True:
+                if bHaveS:
                     print('  voltage_1 ' + vstarta + ';', file=op)
                     print('  voltage_2 ' + vstarta + ';', file=op)
                 else:
                     print('  voltage_A ' + vstarta + ';', file=op)
             if 'voltage_B' in model[t][o]:
-                if bHaveS == True:
+                if bHaveS:
                     print('  voltage_1 ' + vstartb + ';', file=op)
                     print('  voltage_2 ' + vstartb + ';', file=op)
                 else:
                     print('  voltage_B ' + vstartb + ';', file=op)
             if 'voltage_C' in model[t][o]:
-                if bHaveS == True:
+                if bHaveS:
                     print('  voltage_1 ' + vstartc + ';', file=op)
                     print('  voltage_2 ' + vstartc + ';', file=op)
                 else:
@@ -2120,7 +2120,7 @@ def ProcessTaxonomyFeeder(outname, rootname, vll, vln, avghouse, avgcommercial):
         if metrics_interval > 0:
             print('object metrics_collector_writer {', file=op)
             print('  interval', str(metrics_interval) + ';', file=op)
-            if forERCOT == True:
+            if forERCOT:
                 print('  // filename ${METRICS_FILE};', file=op)
                 print('  filename ' + outname + '_metrics.json;', file=op)
             else:
@@ -2268,7 +2268,7 @@ def ProcessTaxonomyFeeder(outname, rootname, vll, vln, avghouse, avgcommercial):
         write_link_class(model, h, 'transformer', seg_loads, op)
         write_link_class(model, h, 'capacitor', seg_loads, op)
 
-        if forERCOT == True:
+        if forERCOT:
             identify_ercot_houses(model, h, 'load', 0.001 * avghouse, rgn)
             connect_ercot_houses(model, h, op, vln, 120.0)
             for key in house_nodes:
@@ -2287,7 +2287,7 @@ def ProcessTaxonomyFeeder(outname, rootname, vll, vln, avghouse, avgcommercial):
 
         write_voltage_class(model, h, 'node', op, vln, vll, secnode)
         write_voltage_class(model, h, 'meter', op, vln, vll, secnode)
-        if forERCOT == False:
+        if not forERCOT:
             write_voltage_class(model, h, 'load', op, vln, vll, secnode)
         if len(Eplus_Bus) > 0 and Eplus_Volts > 0.0 and Eplus_kVA > 0.0:
             print('////////// EnergyPlus large-building load ///////////////', file=op)