Skip to content

Commit 3b61af8

Browse files
authored
stage renamed as "view" and was more explicit about where m.fs comes from
1 parent 6ec97f3 commit 3b61af8

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

Diff for: docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ README for IDAES-UI docs
1010
# Change to the docs directory
1111

1212
# Install the required packages
13-
pip install -r requirement.txt
13+
pip install -r requirements.txt
1414

1515
# Install sphinx-autobuild
1616
# This is necessary for building a local development server to view live changes.

Diff for: docs/user/save-diagram/index.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
IDAES UI allows you to preview your flowsheet diagram at any time while working on it by calling `export_flowsheet_diagram`.
66

77
### Usage:
8-
The export_flowsheet_diagram function is used to return the current stage of the flowsheet diagram at any time after you have initialized your model.
8+
The export_flowsheet_diagram function is used to return the current view of the flowsheet diagram at any time after you have initialized your model.
99
* It can save the diagram to your preferred path or the default path.
10-
* It can display the current stage of the flowsheet diagram in a Jupyter Notebook.
10+
* It can display the current view of the flowsheet diagram in a Jupyter Notebook.
1111

1212
### Parameters:
1313
`export_flowsheet_diagram` takes three parameters:
@@ -16,18 +16,20 @@ The export_flowsheet_diagram function is used to return the current stage of the
1616
* `display`: Boolean, to determent if you want to review current flowsheet in jupyter notebook
1717

1818
#### Let's go over it step by step.
19-
1. Import `export_flowsheet_diagram` function from `idaes_ui package`
19+
1. Import `export_flowsheet_diagram` function from `idaes_ui` package
2020
```python
2121
from idaes_ui.fv.fsvis import export_flowsheet_diagram
2222
```
23+
2. Create your model. Here we assume the model is called `m` and
24+
the top-level flowsheet that you want to view is `m.fs`.
2325

24-
2. After initializing your model, you should have `m.fs`.
26+
3. After initializing your model, you should have `m.fs`.
2527
Then, you can call `export_flowsheet_diagram`.
2628
```python
2729
export_flowsheet_diagram(m.fs, '~/Download/my_flowsheet_diagram.svg', display=True)
2830
```
2931

30-
3. Then, you can see the flowsheet diagram's saved path in the log.
32+
4. Then, you can see the flowsheet diagram's saved path in the log.
3133

3234
### View flowsheet diagram
3335
1. To view the image, after calling `export_flowsheet_diagram`, you can visit the path shown in the log.

0 commit comments

Comments
 (0)