Push latest main to branch (#1394)

* Resolve CI failures from new version (1.20.4) of spellchecker (#1389) * Empty commit to verify failures on main * Resolve likely false positives * Resolve likely true positives * Resolve probable true positive * Remove "frst" from typos exclusions * Remove "ans" from typos exclusions b/c crate-ci/typos#981 * Fix target for 'fv' (flowsheet visualizer) reference (#1391) * outputs * fix hyperlink * put this back * put this back2 * replace with simple hyperlink * Updating black and rerunning it on all files (#1388) * Updating black and rerunning it on all files * Remove duplicated Black requirement * Update Black rev in pre-commit config --------- Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov> --------- Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov> Co-authored-by: Dan Gunter <dkgunter@lbl.gov> Co-authored-by: Keith Beattie <ksbeattie@lbl.gov>
IDAES · Apr 10, 2024 · 88553c1 · 88553c1
1 parent 8948c6c
commit 88553c1
Show file tree

Hide file tree

Showing 71 changed files with 291 additions and 579 deletions.
diff --git a/.github/actions/run-examples/examples_for_idaes_ci.py b/.github/actions/run-examples/examples_for_idaes_ci.py
@@ -1,6 +1,7 @@
 """
 pytest plugin for testing IDAES "through" IDAES/examples within the IDAES/idaes-pse CI
 """
+
 from contextlib import contextmanager
 from dataclasses import dataclass, field
 import fnmatch

diff --git a/.github/workflows/typos.toml b/.github/workflows/typos.toml
@@ -38,3 +38,10 @@ astroid = "astroid"
 delt = "delt"
 # TEMPORARY - Remove after example update
 upadate = "upadate"
+
+# false positive from 1.20.3
+RTO = "RTO"
+PN = "PN"
+hd = "hd"
+Tge = "Tge"
+iy = "iy"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 24.3.0
     hooks:
     - id: black
       language_version: python3

diff --git a/.pylint/idaes_transform.py b/.pylint/idaes_transform.py
@@ -4,6 +4,7 @@
 
 See #1159 for more information.
 """
+
 from dataclasses import dataclass
 import sys
 import functools

diff --git a/docs/explanations/components/ui/index.rst b/docs/explanations/components/ui/index.rst
@@ -4,7 +4,7 @@ User Interfaces
 There are several types of user interfaces in IDAES.
 To learn more about them, follow the links below.
 
-* Graphical user interfaces: see `Flowsheet Visualizer <https://idaes-ui.readthedocs.io/en/latest/fv.html>`_
+* Graphical user interfaces: see `Flowsheet Visualizer <https://idaes-ui.readthedocs.io/en/latest/user/fv/>`_
 * `Jupyter Notebooks <https://jupyter.org/>`_: see `IDAES Examples <https://idaes-examples.readthedocs.io/en/latest/>`_
 * Python Application Programming Interfaces (APIs): see :ref:`API Reference`
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -67,7 +67,7 @@ Contents
          | :doc:`Logging Processing & Outputs <reference_guides/logging>`
          | :doc:`Developing for IDAES <reference_guides/developer/index>`
          | :doc:`Grid integration application <reference_guides/apps/grid_integration/index>`
-         | :external+ui:doc:`Flowsheet Visualizer <fv>`
+         | `Flowsheet Visualizer <https://idaes-ui.readthedocs.io/en/latest/user/fv/>`_
 
 .. toctree::
     :hidden:

diff --git a/docs/reference_guides/model_libraries/generic/costing/process_costing_sslw.rst b/docs/reference_guides/model_libraries/generic/costing/process_costing_sslw.rst
@@ -138,7 +138,7 @@ Heat Exchanger Cost
 
 .. note:: IDAES does not yet support costing for heat exchangers requiring both shell and tube area (HX1D).
 
-The purchse cost is computed based on the base unit cost and three correction factors (Eq. 22.43 in Seider et al.), and is adjusted by user-defined currency units with the appropriate CE index value. The base cost is computed depending on the heat exchanger type selected by the user.
+The purchase cost is computed based on the base unit cost and three correction factors (Eq. 22.43 in Seider et al.), and is adjusted by user-defined currency units with the appropriate CE index value. The base cost is computed depending on the heat exchanger type selected by the user.
 
 The heat exchanger costing method has three arguments, hx_type = heat exchanger type, material_type = construction material, and tube_length = tube length ('*' corresponds to the default options):
 

diff --git a/...ference_guides/model_libraries/generic/property_models/activity_coefficient.rst b/...ference_guides/model_libraries/generic/property_models/activity_coefficient.rst
@@ -28,7 +28,7 @@ Option 1 - "FTPz":
       	<ul>
  	<li>Total molar flow rate (mol/s) - <code> <font color="red"> flow_mol </font> </code>
  	<li>Temperature (K) - <code> <font color="red"> temperature </font> </code>
-	<li>Presure (Pa) - <code> <font color="red"> pressure</font></code>
+	<li>Pressure (Pa) - <code> <font color="red"> pressure</font></code>
 	<li>Mole fraction of the mixture - <code> <font color="red"> mole_frac_comp</font></code> 
 	</ul>
 	</body>
@@ -43,7 +43,7 @@ Option 2 - "FcTP":
       	<ul>
  	<li>Component molar flow rate (mol/s) - <code> <font color="red"> flow_mol_comp </font> </code>
  	<li>Temperature (K) - <code> <font color="red"> temperature </font> </code>
-	<li>Presure (Pa) - <code> <font color="red"> pressure</font></code>
+	<li>Pressure (Pa) - <code> <font color="red"> pressure</font></code>
 	</ul>
 	</body>
 

diff --git a/docs/reference_guides/model_libraries/generic/property_models/ceos.rst b/docs/reference_guides/model_libraries/generic/property_models/ceos.rst
@@ -183,7 +183,7 @@ List of Variables
    "``fug_phase_comp``", "Fugacity indexed by phase and component", "Pa"
    "``fug_coeff_phase_comp``", "Fugacity coefficient indexed by phase and component", "None"
    "``gibbs_mol_phase``", "Molar Gibbs energy indexed by phase", "J/mol"
-   "``heat_capacity_ratio_phase``", "Heat capcity ratio by phase", "-"
+   "``heat_capacity_ratio_phase``", "Heat capacity ratio by phase", "-"
    "``isothermal_speed_sound_phase``", "Isothermal speed of sound by phase", "m/s"
    "``isentropic_speed_sound_phase``", "Isentropic speed of sound by phase", "m/s"
    "``mw``", "Molecular weight of mixture", "kg/mol"

diff --git a/...ce_guides/model_libraries/power_generation/costing/power_plant_costing_netl.rst b/...ce_guides/model_libraries/power_generation/costing/power_plant_costing_netl.rst
@@ -300,7 +300,7 @@ The function has has five arguments, self, equipment, scaled_param, temp_C, and
 * self : an existing unit model or Pyomo Block
 * equipment : The type of equipment to be costed, see table 6
 * scaled_param : The Pyomo Variable representing the component's scaled parameter
-* temp_C : The Pyomo Variable representing the hottest temperature of the piece of equiment being costed. Some pieces of equipment do not have a temperature associated with them, so the default argument is None. This variable must have units of Celsius (Pyomo label `pyunits.C`).
+* temp_C : The Pyomo Variable representing the hottest temperature of the piece of equipment being costed. Some pieces of equipment do not have a temperature associated with them, so the default argument is None. This variable must have units of Celsius (Pyomo label `pyunits.C`).
 * n_equip : The number of pieces of equipment to be costed. The function will evenly divide the scaled parameter between the number passed.
 * CE_index_year : Chemical Engineering Cost Index base year, defaults to 2018; calling the registered Pyomo currency units dictionary of plant cost index values will allow conversion between base years within the flowsheet
 * custom_accounts : Additional accounts to cost