Skip to content

Commit

Permalink
Merge branch 'main' into spell-checker
Browse files Browse the repository at this point in the history
  • Loading branch information
lbianchi-lbl committed Apr 25, 2024
2 parents 3f29630 + f62f20f commit cee47bf
Show file tree
Hide file tree
Showing 38 changed files with 15,184 additions and 3,341 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ idaes_examples/notebooks/**/pysmo/*.pickle
idaes_examples/notebooks/**/omlt/keras_surrogate/*.pb
idaes_examples/notebooks/**/omlt/keras_surrogate/*.pdf
idaes_examples/notebooks/**/omlt/*.pdf
idaes_examples/notebooks/docs/power_gen/solid_oxide_cell/soc_dynamic_flowsheet.svg
alamo_run.alm
idaes_examples/notebooks/docs/tut/sin_data.csv
*.pb
Expand Down
4 changes: 2 additions & 2 deletions README-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -364,9 +364,9 @@ Create a new virtual environment and install the package from test.pypi into it:
pip install --extra-index-url https://test.pypi.org/simple/ idaes-examples
```

If the installation succeeds, you should be able to browse the notebooks using the built-in GUI:
If the installation succeeds, you should be able to serve the notebooks:
```shell
idaesx gui
idaesx serve
```

If it all looks good, you can repeat the **Upload** step with the real [PyPI](pypi.org)
Expand Down
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,16 @@ to install and run the notebooks in an isolated environment.

Use the command
```
idaesx gui
idaesx serve
```
to get a simple graphical UI that lets you
browse and open notebooks (with Jupyter) for local execution and experimentation.
The GUI will show the description of each notebook and allow selection of tutorial or exercise versions of the notebook, if these exist.
to start a Jupyter server to browser and open the notebooks for local execution and experimentation.

Alternately, you may use Jupyter notebook's file browser in the installed notebooks directory,
using the `idaesx where` command to find that directory:
`jupyter notebook $(idaesx where)`.

Only the source notebooks (ending in '_src.ipynb') are included in the repository.
The `idaesx gui` command will generate the other versions, or you can run preprocessing manually with: `idaesx pre -d "$(idaesx where)\.."`.

The `idaesx serve` command will generate the other versions, or you can run preprocessing manually with: `idaesx pre -d "$(idaesx where)\.."`.

## Build documentation

Expand Down
Binary file not shown.
Binary file not shown.
444 changes: 222 additions & 222 deletions idaes_examples/archive/power_gen/ngfc/NGFC_results.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,246 changes: 342 additions & 904 deletions idaes_examples/archive/power_gen/ngfc/ngfc_flowsheet_src.ipynb

Large diffs are not rendered by default.

Empty file.
33 changes: 0 additions & 33 deletions idaes_examples/archive/ripe/clc.csv

This file was deleted.

34 changes: 0 additions & 34 deletions idaes_examples/archive/ripe/clc.py

This file was deleted.

178 changes: 0 additions & 178 deletions idaes_examples/archive/ripe/clc_nb_src.ipynb

This file was deleted.

Loading

0 comments on commit cee47bf

Please sign in to comment.