diff --git a/.github/workflows/typos.toml b/.github/workflows/typos.toml index 4900a7b560..13bcee5705 100644 --- a/.github/workflows/typos.toml +++ b/.github/workflows/typos.toml @@ -30,5 +30,11 @@ suh = "suh" ther = "ther" # KNO3 KNO = "KNO" +# Equil == equilibrium +equil = "equil" +# Ignore astroid package +astroid = "astroid" +# delt == delta +delt = "delt" # TEMPORARY - Remove after example update -upadate = "upadate" \ No newline at end of file +upadate = "upadate" diff --git a/docs/reference_guides/core/util/model_statistics.rst b/docs/reference_guides/core/util/model_statistics.rst index 0c238ced2f..52b4f8af5a 100644 --- a/docs/reference_guides/core/util/model_statistics.rst +++ b/docs/reference_guides/core/util/model_statistics.rst @@ -8,7 +8,7 @@ The most commonly used methods are ``degrees_of_freedom`` and ``report_statistic Degrees of Freedom Method ------------------------- -The ``degrees_of_freedom`` method calculates the number of degrees of freedom available in a given model. The calcuation is based on the number of unfixed variables which appear in active constraints, minus the number of active equality constraints in the model. Users should note that this method does not consider inequality or deactivated constraints, or variables which do not appear in active equality constraints. +The ``degrees_of_freedom`` method calculates the number of degrees of freedom available in a given model. The calculation is based on the number of unfixed variables which appear in active constraints, minus the number of active equality constraints in the model. Users should note that this method does not consider inequality or deactivated constraints, or variables which do not appear in active equality constraints. .. autofunction:: idaes.core.util.model_statistics.degrees_of_freedom 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 index f11992e56f..a604948398 100644 --- a/docs/reference_guides/model_libraries/generic/costing/process_costing_sslw.rst +++ b/docs/reference_guides/model_libraries/generic/costing/process_costing_sslw.rst @@ -851,7 +851,7 @@ note that if plates = `False`, the cost of trays is not included. Base Cost of Platforms and ladders """""""""""""""""""""""""""""""""" -The cost of platforms and ladders is based on the diamter and length in ft. +The cost of platforms and ladders is based on the diameter and length in ft. Horizontal vessels (1: 3 < D < 12 ft): .. math:: self.base\_cost\_platforms\_ladders = 20059*D^{0.20294} diff --git a/docs/reference_guides/model_libraries/generic/property_models/activity_coefficient.rst b/docs/reference_guides/model_libraries/generic/property_models/activity_coefficient.rst index e532d6ed61..9536d6fe29 100644 --- a/docs/reference_guides/model_libraries/generic/property_models/activity_coefficient.rst +++ b/docs/reference_guides/model_libraries/generic/property_models/activity_coefficient.rst @@ -115,7 +115,7 @@ The equilibrium condition, the fugacity of the vapor and liquid phase are define The equilibrium constraint is written as a generic constraint such that it can be extended easily for non-ideal gases and liquids. As this property package only supports an ideal gas, the fugacity coefficient (:math:`\phi_{i}`) for the vapor phase is 1 and hence the expression reduces to :math:`y_{i}P`. For the liquid phase, if the ideal option is selected then the activity coefficient (:math:`\nu_{i}`) is 1. If an activity coefficient model is selected then corresponding constraints are added to compute the activity coefficient. -Typically, the flash calculations are computed at a given temperature, :math:`T`. However, the flash calculations become trivial if the given conditions do not fall in the two phase region. For simulation only studies, the user may know a priori the condition of the stream but when the same set of equations are used for optimization, there is a high probablity that the specifications can transcend the phase envelope and hence the flash equations included may be trivial in the single phase region (i.e. liquid or vapor only). To circumvent this problem, property packages in IDAES that support VLE will compute the flash calculations at an "equilibrium" temperature :math:`T_{eq}`. The equilibrium temperature is computed as follows: +Typically, the flash calculations are computed at a given temperature, :math:`T`. However, the flash calculations become trivial if the given conditions do not fall in the two phase region. For simulation only studies, the user may know a priori the condition of the stream but when the same set of equations are used for optimization, there is a high probability that the specifications can transcend the phase envelope and hence the flash equations included may be trivial in the single phase region (i.e. liquid or vapor only). To circumvent this problem, property packages in IDAES that support VLE will compute the flash calculations at an "equilibrium" temperature :math:`T_{eq}`. The equilibrium temperature is computed as follows: .. math:: T_{1} = max(T_{bubble}, T) .. math:: T_{eq} = min(T_{1}, T_{dew}) diff --git a/docs/reference_guides/model_libraries/power_generation/unit_models/drum.rst b/docs/reference_guides/model_libraries/power_generation/unit_models/drum.rst index ebb7242500..c97d122771 100644 --- a/docs/reference_guides/model_libraries/power_generation/unit_models/drum.rst +++ b/docs/reference_guides/model_libraries/power_generation/unit_models/drum.rst @@ -62,7 +62,7 @@ Constraints As mentioned above, the drum model imports a `HelmPhaseSeparator` and mixer models, specific documentation for these models can be obtained in: Once the water enters the tank model the main equations calculate water velocity and pressure drop calculation due to gravity based on water level and contraction to downcomer. -Water level (drum_leve) is either fixed for steady state simulation or calculated for dynamic model (Dynamic = True) +Water level (drum_level) is either fixed for steady state simulation or calculated for dynamic model (Dynamic = True) Main assumptions: diff --git a/docs/reference_guides/model_libraries/power_generation/unit_models/drum1D.rst b/docs/reference_guides/model_libraries/power_generation/unit_models/drum1D.rst index 53692d493c..334af46c5b 100644 --- a/docs/reference_guides/model_libraries/power_generation/unit_models/drum1D.rst +++ b/docs/reference_guides/model_libraries/power_generation/unit_models/drum1D.rst @@ -68,7 +68,7 @@ Constraints As mentioned above, the drum model imports a `HelmPhaseSeparator` and mixer models, specific documentation for these models can be obtained in: Once the water enters the tank model the main equations calculate water velocity and pressure drop calculation due to gravity based on water level and contraction to downcomer. -Water level (drum_leve) is either fixed for steady state simulation or calculated for dynamic model (Dynamic = True) +Water level (drum_level) is either fixed for steady state simulation or calculated for dynamic model (Dynamic = True) Main assumptions: diff --git a/idaes/apps/grid_integration/bidder.py b/idaes/apps/grid_integration/bidder.py index 0e2db51032..c1843cc458 100644 --- a/idaes/apps/grid_integration/bidder.py +++ b/idaes/apps/grid_integration/bidder.py @@ -839,7 +839,7 @@ def __init__( forecaster: an initialized LMP forecaster object - fixed_to_schedule: If True, forece market simulator to give the same schedule. + fixed_to_schedule: If True, force market simulator to give the same schedule. Returns: None diff --git a/idaes/commands/util/download_bin.py b/idaes/commands/util/download_bin.py index e87f25532c..c1a385d3d9 100644 --- a/idaes/commands/util/download_bin.py +++ b/idaes/commands/util/download_bin.py @@ -192,7 +192,7 @@ def _download_package(fd, name, frm, to, platform): raise Exception(f"{name} binaries are unavailable for {platform}") -def _verfiy_checksums(checksum, pname, ptar, ftar): +def _verify_checksums(checksum, pname, ptar, ftar): # If release checksum is not False, nochecksum opt allows hash to be ignored if checksum: for n, p, f in zip(pname, ptar, ftar): @@ -391,7 +391,7 @@ def download_binaries( _download_package(fd, n, frm=u, to=p, platform=platform) # Verify checksums - _verfiy_checksums(checksum, pname, ptar, ftar) + _verify_checksums(checksum, pname, ptar, ftar) # Extract solvers links = {} diff --git a/idaes/core/base/control_volume1d.py b/idaes/core/base/control_volume1d.py index 9bfc526e0b..dae0e48ea5 100644 --- a/idaes/core/base/control_volume1d.py +++ b/idaes/core/base/control_volume1d.py @@ -576,7 +576,7 @@ def material_flow_linking_constraints(b, t, x, p, j): self.material_flow_dx = DerivativeVar( self._flow_terms, wrt=self.length_domain, - doc="Parital derivative of material flow " "wrt to normalized length", + doc="Partial derivative of material flow " "wrt to normalized length", units=flow_units, ) diff --git a/idaes/core/base/costing_base.py b/idaes/core/base/costing_base.py index 96b81d6354..1a44c90dd8 100644 --- a/idaes/core/base/costing_base.py +++ b/idaes/core/base/costing_base.py @@ -626,7 +626,7 @@ def initialize(self, *args, **kwargs): Placeholder method for initialization """ # TODO: Implement an initialization method - # TODO: Need to have a general pupose method (block triangularisation?) + # TODO: Need to have a general purpose method (block triangularisation?) # TODO: Should also allow registering custom methods # Vars and Constraints diff --git a/idaes/core/dmf/tests/test_model_data.py b/idaes/core/dmf/tests/test_model_data.py index 04c84041db..a59e51a6f8 100644 --- a/idaes/core/dmf/tests/test_model_data.py +++ b/idaes/core/dmf/tests/test_model_data.py @@ -209,7 +209,7 @@ def test_unit_conversion(): assert p_pa[0] == pytest.approx(101325, rel=1e-1) assert unit == "kilogram / meter / second ** 2" # AKA Pa - # Test for unit conversion of gauge pressue with different atmosperic + # Test for unit conversion of gauge pressure with different atmosperic # pressure values p, unit = da.unit_convert( p_psi, "psig", "atm", ambient_pressure=np.array([1, 1.1, 1.2]) diff --git a/idaes/models_extra/column_models/condenser.py b/idaes/models_extra/column_models/condenser.py index 50001b02fe..05129bc0b1 100644 --- a/idaes/models_extra/column_models/condenser.py +++ b/idaes/models_extra/column_models/condenser.py @@ -225,7 +225,7 @@ def build(self): # outlet pressure is a spec set by the user. # Get liquid and vapor phase objects from the property package - # to be used below. Avoids repition. + # to be used below. Avoids repetition. _liquid_list = [] _vapor_list = [] for p in self.config.property_package.phase_list: diff --git a/idaes/models_extra/column_models/plate_heat_exchanger.py b/idaes/models_extra/column_models/plate_heat_exchanger.py index 3d85022ab4..b54189d577 100644 --- a/idaes/models_extra/column_models/plate_heat_exchanger.py +++ b/idaes/models_extra/column_models/plate_heat_exchanger.py @@ -187,7 +187,7 @@ def build(self): initialize=0.2045, units=units_meta("length"), domain=PositiveReals, - doc="Port diamter", + doc="Port diameter", ) self.plate_therm_cond = Var( diff --git a/idaes/models_extra/column_models/reboiler.py b/idaes/models_extra/column_models/reboiler.py index efe17bbe7f..3e3420e4ca 100644 --- a/idaes/models_extra/column_models/reboiler.py +++ b/idaes/models_extra/column_models/reboiler.py @@ -207,7 +207,7 @@ def build(self): ) # Get liquid and vapor phase objects from the property package - # to be used below. Avoids repition. + # to be used below. Avoids repetition. _liquid_list = [] _vapor_list = [] for p in self.config.property_package.phase_list: diff --git a/idaes/models_extra/column_models/tray.py b/idaes/models_extra/column_models/tray.py index ea930d684a..ec741e4a69 100644 --- a/idaes/models_extra/column_models/tray.py +++ b/idaes/models_extra/column_models/tray.py @@ -220,7 +220,7 @@ def build(self): self._add_pressure_balance() # Get liquid and vapor phase objects from the property package - # to be used below. Avoids repition. + # to be used below. Avoids repetition. _liquid_list = [] _vapor_list = [] for p in self.config.property_package.phase_list: diff --git a/idaes/models_extra/power_generation/flowsheets/subcritical_power_plant/steam_cycle_flowsheet.py b/idaes/models_extra/power_generation/flowsheets/subcritical_power_plant/steam_cycle_flowsheet.py index 3679b6f84d..8ed413b4c1 100644 --- a/idaes/models_extra/power_generation/flowsheets/subcritical_power_plant/steam_cycle_flowsheet.py +++ b/idaes/models_extra/power_generation/flowsheets/subcritical_power_plant/steam_cycle_flowsheet.py @@ -845,7 +845,7 @@ def set_inputs(m): fs.fwh5.desuperheat.overall_heat_transfer_coefficient.fix(145) fs.fwh5.cooling.overall_heat_transfer_coefficient.fix(675) fs.fwh5.condense.tube.deltaP[:].fix(0) - # Inputs reqired for dynamic model + # Inputs required for dynamic model fs.fwh5.condense.level.fix(0.275) fs.fwh5.condense.heater_diameter.fix(1.4) fs.fwh5.condense.vol_frac_shell.fix(0.675) diff --git a/idaes/models_extra/power_generation/unit_models/helm/condenser_ntu.py b/idaes/models_extra/power_generation/unit_models/helm/condenser_ntu.py index 80cee87ca6..80cf3c7a90 100644 --- a/idaes/models_extra/power_generation/unit_models/helm/condenser_ntu.py +++ b/idaes/models_extra/power_generation/unit_models/helm/condenser_ntu.py @@ -82,7 +82,7 @@ def _make_heat_exchanger_config(config): @declare_process_block_class("HelmNtuCondenser", doc="Simple 0D condenser model.") class HelmNtuCondenserData(UnitModelBlockData): """ - Simple NTU condenser unit model. This model assumes the property pacakages + Simple NTU condenser unit model. This model assumes the property packages specified are Helmholtz EOS type. """