Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update looptool documentation #1524

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update looptool documentation #1524

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
148cb19
update looptool documentation
johnson12742 Nov 13, 2024
d80a993
Update docs/how_to_guides/how_to_use_loopTool_to_explore_flowsheets.rst
johnson12742 Nov 14, 2024
515a530
Corrections to the documentation
johnson12742 Nov 22, 2024
b2127fb
Merge remote-tracking branch 'origin/looptool_doc' into looptool_doc
johnson12742 Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/how_to_guides/how_to_use_loopTool_to_explore_flowsheets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ How to use loopTool to explore flowsheets
=========================================

.. index::
pair: watertap.tools.analysis_tools.loop_tool;loop_tool
pair: parameter_sweep.loop_tool;loop_tool

.. currentmodule:: watertap.tools.analysis_tools.loop_tool
.. currentmodule:: parameter_sweep.loop_tool

The loopTool is a wrapper for the parameter sweep (PS) tool set, and is designed to simplify setting up parametric sweeps, enabling sweeping over discrete design choices, and providing structured data management.

Expand Down Expand Up @@ -143,7 +143,9 @@ The sweep_param_loop parameters will be iterated over one by one, to sweep over
param: key on the flowsheet that can be found using m.find_component (e.g., fs.costing.reverse_osmosis.membrane_cost)
lower_limit: lower value for sampling
upper_limit: upper value for sampling
num_samples: number of samples to run
num_samples: number of samples to run

Please note that YAML only supports literals for numeric data types. Expression-like values such as ``150 * 0.8`` will be parsed as strings and cause errors once the YAML inputs have been loaded.

**Defining diff_param_loop**

Expand Down Expand Up @@ -365,7 +367,7 @@ Example of code for setting up our example of RO with ERD
# This imports the function created in the example for RO_with_energy_recovery above
import ro_erd as ro_setup
# import the loopTool and utility function for getting a working directory
from watertap.tools.analysis_tools.loop_tool.loop_tool import loopTool, get_working_dir
from parameter_sweep.loop_tool.loop_tool import loopTool, get_working_dir

if __name__=='__main__': we will execute the loopTool script here, required for safe execution of parallel scripts
# We assume our .yaml file is in the same directory as this script
Expand Down
Loading