Apply black format to the whole repository

.github/workflows/lint.yml

@@ -14,4 +14,5 @@ jobs:
           options: "-S -C --check --diff"
       - name: Spell Check
         uses: crate-ci/typos@master
-
+        with:
+          config: ./.github/workflows/typos.toml

.github/workflows/typos.toml

@@ -0,0 +1,5 @@
+[default.extend-words]
+# Ignore HDA
+hda = "hda"
+HDA = "HDA"
+equil = "equil"

gdplib/biofuel/model.py

@@ -44,7 +44,7 @@ def build_model():
     Returns
     -------
     Pyomo.ConcreteModel
-        The Pyomo concrete model which descibes the multiperiod location-allocation optimization model designed to determine the most cost-effective network layout and production allocation to meet market demands.
+        The Pyomo concrete model which describes the multiperiod location-allocation optimization model designed to determine the most cost-effective network layout and production allocation to meet market demands.
 
     References
     ----------
@@ -72,7 +72,7 @@ def discount_factor(m, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         t : int
             Index of time in months from 0 to 120 (10 years)
 
@@ -97,7 +97,7 @@ def market_demand(m, mkt, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         mkt : int
             Index of the market from 1 to 10
         t : int
@@ -121,7 +121,7 @@ def available_supply(m, sup, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
         t : int
@@ -149,7 +149,7 @@ def supplier_x(m, sup):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
 
@@ -168,7 +168,7 @@ def supplier_y(m, sup):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
 
@@ -187,7 +187,7 @@ def market_x(m, mkt):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         mkt : int
             Index of the market from 1 to 10
 
@@ -206,7 +206,7 @@ def market_y(m, mkt):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         mkt : int
             Index of the market from 1 to 10
 
@@ -225,7 +225,7 @@ def site_x(m, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
 
@@ -244,7 +244,7 @@ def site_y(m, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
 
@@ -263,7 +263,7 @@ def dist_supplier_to_site(m, sup, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
         site : int
@@ -287,7 +287,7 @@ def dist_site_to_market(m, site, mkt):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         mkt : int
@@ -362,7 +362,7 @@ def raw_material_unit_cost(m, sup, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
         t : int
@@ -383,7 +383,7 @@ def module_unit_cost(m, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         t : int
             Index of time in months from 0 to 120 (10 years)
 
@@ -402,7 +402,7 @@ def unit_production_cost(m, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         t : int
             Index of time in months from 0 to 120 (10 years)
 
@@ -421,7 +421,7 @@ def transport_fixed_cost(m):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
 
         Returns
         -------
@@ -438,7 +438,7 @@ def unit_product_transport_cost(m, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         t : int
             Index of time in months from 0 to 120 (10 years)
 
@@ -457,7 +457,7 @@ def unit_raw_material_transport_cost(m, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         t : int
             Index of time in months from 0 to 120 (10 years)
 
@@ -493,7 +493,7 @@ def supply_limits(m, sup, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
         t : int
@@ -517,7 +517,7 @@ def demand_satisfaction(m, mkt, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         mkt : int
             Index of the market from 1 to 10
         t : int
@@ -541,7 +541,7 @@ def product_balance(m, site, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         t : int
@@ -564,7 +564,7 @@ def require_raw_materials(m, site, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         t : int
@@ -625,7 +625,7 @@ def site_type(m, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
 
@@ -644,7 +644,7 @@ def supply_route_active_or_not(m, sup, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             Index of the supplier from 1 to 10
         site : int
@@ -665,7 +665,7 @@ def product_route_active_or_not(m, site, mkt):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         mkt : int
@@ -686,7 +686,7 @@ def raw_material_transport_cost(m, sup, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         sup : int
             _description_
         site : int
@@ -713,7 +713,7 @@ def raw_material_fixed_transport_cost(m):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
 
         Returns
         -------
@@ -738,7 +738,7 @@ def product_transport_cost(m, site, mkt):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         mkt : int
@@ -765,7 +765,7 @@ def product_fixed_transport_cost(m):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
 
         Returns
         -------
@@ -792,7 +792,7 @@ def module_setup_cost(m, site, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         t : int
@@ -817,7 +817,7 @@ def module_teardown_credit(m, site, t):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
         t : int
@@ -838,7 +838,7 @@ def conv_salvage_value(m, site):
         Parameters
         ----------
         m : Pyomo.ConcreteModel
-            Pyomo concrete model which descibes the multiperiod location-allocation optimization model
+            Pyomo concrete model which describes the multiperiod location-allocation optimization model
         site : int
             Index of the facility site from 1 to 12
 

gdplib/gdp_col/column.py

@@ -325,7 +325,7 @@ def monotonoic_temperature(_, t):
     m.gamma = Var(
         m.comps,
         m.trays,
-        doc='liquid activity coefficent of component on tray',
+        doc='liquid activity coefficient of component on tray',
         domain=NonNegativeReals,
         bounds=(0, 10),
         initialize=1,

gdplib/gdp_col/fenske.py

@@ -50,7 +50,7 @@ def calculate_Fenske(xD, xB):
     m.gamma = Var(
         m.comps,
         m.trays,
-        doc='liquid activity coefficent of component on tray',
+        doc='liquid activity coefficient of component on tray',
         domain=NonNegativeReals,
         bounds=(0, 10),
         initialize=1,

gdplib/gdp_col/initialize.py

@@ -1,4 +1,5 @@
 """Initialization routine for distillation column"""
+
 from __future__ import division
 
 import pandas
@@ -173,12 +174,7 @@ def set_value_if_not_fixed(var, val):
             m.Pvap[c, t].set_value(
                 value(
                     exp(
-                        (
-                            k['A'] * x
-                            + k['B'] * x**1.5
-                            + k['C'] * x**3
-                            + k['D'] * x**6
-                        )
+                        (k['A'] * x + k['B'] * x**1.5 + k['C'] * x**3 + k['D'] * x**6)
                         / (1 - x)
                     )
                     * k['Pc']