diff --git a/docs/DeveloperGuide_2_MethodsFunctions.md b/docs/DeveloperGuide_2_MethodsFunctions.md index 95ce233..04eedd4 100644 --- a/docs/DeveloperGuide_2_MethodsFunctions.md +++ b/docs/DeveloperGuide_2_MethodsFunctions.md @@ -1,5 +1,5 @@ # Methods, Functions, Classes, and Input Handling -This section includes detials on input handling, and describes all exisitng funcitons, methods, and classes to inform future contributors. +This section includes details on input handling, and describes all existing functions, methods, and classes to inform future contributors. ## Input Handling {numref}`HG_InputH` shows how input parameters are handled in **_HydroGenerate_**. For details on inputs and outputs, data types, units, and a general view of the workflow visit [](UserGuide_7_HydroGenerateWorkflow.md). @@ -12,7 +12,7 @@ Input Handling ``` ## Computations Workflow, methods, functions, and classes -{numref}`DetWorkflow` shows methods, functions, and classes avaliable in **_HydroGenerate_**. +{numref}`DetWorkflow` shows methods, functions, and classes available in **_HydroGenerate_**. ```{figure} DetailedWorkflow.SVG --- diff --git a/docs/GettingStarted_2_QuickStart.md b/docs/GettingStarted_2_QuickStart.md index bb773b3..f56756c 100644 --- a/docs/GettingStarted_2_QuickStart.md +++ b/docs/GettingStarted_2_QuickStart.md @@ -26,7 +26,7 @@ The results are returned in an object with multiple attributes. In the example a ## Time-series usage -HydroGenerate truly shines when used with a time-series. The tool can be used in several applications such as dispatch optimization of hydropower hybrids, techno-economic assessment, nation-wide resource assesment, etc. The best way to utilize the time-series capabilities is through a **pandas dataframe**. Note: The file data_test.csv used in the examples below is available in the ./examples/ directory of the repository. The Jupyter notebook files for all examples are located in the jugc-docs branch, within the docs folder. +HydroGenerate truly shines when used with a time-series. The tool can be used in several applications such as dispatch optimization of hydropower hybrids, techno-economic assessment, nation-wide resource assessment, etc. The best way to utilize the time-series capabilities is through a **pandas dataframe**. Note: The file data_test.csv used in the examples below is available in the ./examples/ directory of the repository. The Jupyter notebook files for all examples are located in the jugc-docs branch, within the docs folder. ``` # Local imports diff --git a/docs/Theory_1_Hydropower.md b/docs/Theory_1_Hydropower.md index 9ec756c..5cd5f0f 100644 --- a/docs/Theory_1_Hydropower.md +++ b/docs/Theory_1_Hydropower.md @@ -12,12 +12,12 @@ where, * $Q$ is the flow (m^3/s), and * $H$ is the net hydraulic head (m). -HG uses a simplified configuration, consisting of one penstock, turbine, and generator. The turbine type is selected based on head and design flow. Penstock, turbine diamter and other element are sized for a [design flow](Theory_2_Design_Flow.md) that can be entered by the user or computed in HG, using flow data. The overall efficiency of the system is calculated as $\eta = e_{turb}*e_{gen}$, where $e_{turb}$ and $e_{gen}$ are turbine and generator efficiencies. Turbine efficiencies at flows below or above the design flow are computed using a set of [empirical equations](Theory_3_Efficiency.md) for each turbine type (CANMET, 2004), while considering constant generator efficiency. +HG uses a simplified configuration, consisting of one penstock, turbine, and generator. The turbine type is selected based on head and design flow. Penstock, turbine diameter and other element are sized for a [design flow](Theory_2_Design_Flow.md) that can be entered by the user or computed in HG, using flow data. The overall efficiency of the system is calculated as $\eta = e_{turb}*e_{gen}$, where $e_{turb}$ and $e_{gen}$ are turbine and generator efficiencies. Turbine efficiencies at flows below or above the design flow are computed using a set of [empirical equations](Theory_3_Efficiency.md) for each turbine type (CANMET, 2004), while considering constant generator efficiency. HG considers the streamflow provided by the user to be the flow routed through the hydropower plant. In some instances, e.g., multi-purpose operation reservoir, the amount of flow routed through the power system, and its operation, obey different priorities and must be analyzed outside HG to compute the flow available for hydropower generation. The considerations and analyses needed to generate the available-for-hydropower flow are outside the scope of the current version of HG. ### HG Workflow -HG can currently compute hydropower under three hydropower types: Basic, Diversion, and Hydrokinetic. The [User Guide section](UserGuide_1_IntroductionTutorial.ipynb) includes multiple examples that illustrate each of these hydropwoer types as well as additional funcitionality. +HG can currently compute hydropower under three hydropower types: Basic, Diversion, and Hydrokinetic. The [User Guide section](UserGuide_1_IntroductionTutorial.ipynb) includes multiple examples that illustrate each of these hydropwoer types as well as additional functionality. ### Basic hydropower calculation: Required inputs: Hydraulic head, flow, rated power. In the basic calculation mode, users can input two of these three variables and HG will calculate the third. @@ -29,11 +29,11 @@ Optional inputs: all the inputs listed in Table 1 in the [User Guide section](Us ### Computation Steps: 1. Compute head losses using the method described in the [Theory Section - Head Loss Estimation](Theory_4_HeadLoss.md). 2. Calculate the design flow as described in the [Theory Section - Design Flow Estimation](Theory_2_Design_Flow.md) ($Q_d$). -3. Select the turbine type based on the net hydraulic head and design flow folowing the graph included in the [Theory Section - Turbine Selection](Theory_3_Efficiency.md). +3. Select the turbine type based on the net hydraulic head and design flow following the graph included in the [Theory Section - Turbine Selection](Theory_3_Efficiency.md). 4. Calculate turbine efficiency using the corresponding turbine equation included in the [Theory Section - Turbine Efficiency](Theory_3_Efficiency.md) for flows above and below the design flow. Turbine efficiency is calculated following the methodology presented in the Clean Energy Project Analysis electronic textbook (CANMET Energy Technology Center, 2004) -5. Estimate estimate power for the value (s) of flow provided the user implementing any contraint selected. Flow constraints are discussed in the [Theory Section - Flow Constraints](Theory_6_FlowConstraints.md) +5. Estimate estimate power for the value (s) of flow provided the user implementing any constraint selected. Flow constraints are discussed in the [Theory Section - Flow Constraints](Theory_6_FlowConstraints.md) 6. Compute the overall efficiency of the system. The overall efficiency of the system is computed as the turbine efficiency (calculated in step 4) times the Generator efficiency. -7. Compute estimated power potential using the hydropower euqation at the top of this document. +7. Compute estimated power potential using the hydropower equation at the top of this document. 8. Compute all economic parameters as described in the [Theory Section - Cost, O&M, and Revenue Calculation](Theory_5_CostOM.md). Output: the list of outputs will depend on the inputs used. In the most complete case, the output list includes all the variables listed in Table 2 in the [User Guide section](UserGuide_7_HydroGenerateWorkflow.md), except for those resulting from hydrokinetic calculations. diff --git a/docs/Theory_5_CostOM.md b/docs/Theory_5_CostOM.md index 9222d02..ce6e4cc 100644 --- a/docs/Theory_5_CostOM.md +++ b/docs/Theory_5_CostOM.md @@ -5,7 +5,7 @@ Cost and O&M are calculated using the _Hydropower Baseline Cost Modeling, Versio ##### Initial Capital Cost (ICC) -Cost for hydropower project is calcualted using the following equations (ORNL, 2015): +Cost for hydropower project is calculated using the following equations (ORNL, 2015): | # | Resource Category (HG) | Cost Model Equation * | | :--- | :---: | :---: | @@ -31,7 +31,7 @@ $$Annual O\&M (2014\$) = 225,417 P^{0.547}$$ The _Hydropower Baseline Cost Modeling, Version 2_ report (ORNL, 2015) recommends using the lesser of 2.5% of ICC or the result of the equation above. This recommendation is implemented in HG. ## Revenue -Revenue is computed assuming a unique electricty price. The default is 0.0582 $/kW, which is the average wholesale electricity price in 2023 https://www.eia.gov/electricity/wholesale/ +Revenue is computed assuming a unique electricity price. The default is 0.0582 $/kW, which is the average wholesale electricity price in 2023 https://www.eia.gov/electricity/wholesale/ ## References Oak Ridge Natiional Laboratory, 2015. Hydropower Baseline Cost Modeling, Version 2. https://info.ornl.gov/sites/publications/files/Pub58666.pdf \ No newline at end of file diff --git a/docs/Theory_6_FlowConstraints.md b/docs/Theory_6_FlowConstraints.md index e742854..dee1277 100644 --- a/docs/Theory_6_FlowConstraints.md +++ b/docs/Theory_6_FlowConstraints.md @@ -7,9 +7,9 @@ The 'minimum_turbineflow' parameter, can be us ### Workflow Once design flow is calculated and turbine type is determined, the flow and maintenance constraints are executed in the following order: -1. Maximum flow constraint: Limits the maxmimum permissible flow through the turbine to the design flow value. +1. Maximum flow constraint: Limits the maximum permissible flow through the turbine to the design flow value. 2. Minimum flow constraint: Limits the minimum flow through the turbine to the specified minimum value. If the minimum value is not specified, the program assumes 10% of design flow as the minimum flow. 3. Major maintenance constraint: Major maintenance is assumed to last for 2 weeks every 5 years. This constraint limits the flow to 0 during the 2 week that have the lowest flow in one year. -4. Anual maintenance constraint: Annual maintenance is assumed to last for 1 week annualy. This constraint limits the flow to 0 during the week of the lowest flow in one year. If a year is selected for Major maintanence, annual maintenance is not performed. +4. Anual maintenance constraint: Annual maintenance is assumed to last for 1 week annually. This constraint limits the flow to 0 during the week of the lowest flow in one year. If a year is selected for Major maintenance, annual maintenance is not performed. The modified turbine flow generated by applying the above constraints is then used for power output calculations. diff --git a/docs/UserGuide_7_HydroGenerateWorkflow.md b/docs/UserGuide_7_HydroGenerateWorkflow.md index e0b4ba8..a9c2ef5 100644 --- a/docs/UserGuide_7_HydroGenerateWorkflow.md +++ b/docs/UserGuide_7_HydroGenerateWorkflow.md @@ -1,5 +1,5 @@ # Inputs / Outputs - General Workflow -This section describes all avaliable inputs and outputs and presents a graphic with general workflow computations intended to all HydroGenerate users. The section [Methods, functions, classes, and input handling](DeveloperGuide_2_MethodsFunctions.md) includes detials on input handling, and describes all exisitng funcitons, methods, and classes to inform future contributors. +This section describes all available inputs and outputs and presents a graphic with general workflow computations intended to all HydroGenerate users. The section [Methods, functions, classes, and input handling](DeveloperGuide_2_MethodsFunctions.md) includes details on input handling, and describes all existing functions, methods, and classes to inform future contributors. ## General Computations Workflow {numref}`GWorkflow` shows the general workflow computations followed in **_HydroGenerate_**. @@ -98,7 +98,7 @@ General Computations Workflow | 31 | penstock_length | Penstock length | Numerical | - | ft | m | | 32 | penstock_material_o | Penstock material | String | CastIron, Concrete, GalvanizedIron, Plastic, Steel | - | - | | 33 | power | Power output for different values of flow | Series | | KW | KW | -| 34 | rated_power | Power output at design flow, nameplace capcity | Numerical | - | kW | kW | +| 34 | rated_power | Power output at design flow, nameplace capacity | Numerical | - | kW | kW | | 35 | resource_category | Type of hydroelectryc project category | String | NewStream-reach, Non-PoweredDam, CanalConduit, UnitAddition, GeneratorRewind | - | - | | 36 | runner_diameter | Turbine runner diameter | Numeric | - | ft | m | | 37 | system_efficiency | Total efficiency of the system. Total efficiency = turbine efficieincy * generator efficiency | Numerical / Percent | 1 - 100 | DL* | diff --git a/examples/readme.md b/examples/readme.md index b80306c..38f7603 100644 --- a/examples/readme.md +++ b/examples/readme.md @@ -5,5 +5,5 @@ Multiple example files are included to illustrate **HydroGenerate (HG)** functio 1. **BasicMode.ipynb** describes how to use HG in basic mode, i.e., to calculate head, power, or flow, based on the other two. 2. **EconomicCalculation.ipynb** presents functionality to compute projects initial capital cost (ICC) and Operation and Maintenance (O&M). -3. **DiversionMode.ipynb** describes how to estimate hydropower potential for run-of-river facilities. Most HG's functionalty are accessed in Diversion Mode. +3. **DiversionMode.ipynb** describes how to estimate hydropower potential for run-of-river facilities. Most HG's functionality are accessed in Diversion Mode. 4. **Hydrokinetics.ipynb** describes how to use HG to compute hydrokinetic potential. \ No newline at end of file