Reorganize example, testing and tutorial dir trees

CCSI-Toolset / FOQUS

FOQUS: Framework for Optimization and Quantification of Uncertainty and Surrogates

https://foqus.readthedocs.io

Other

46 stars 54 forks source link

Reorganize example, testing and tutorial dir trees #558

Closed ksbeattie closed 4 years ago

ksbeattie commented 5 years ago

The existing structure is somewhat confusing and not well-understood, perhaps with unneeded, broken tests, etc. We should clean this up, add readme.md files and re-organize it so it is more up-to-date and easier to understand.

Use this issue for making suggestions on exactly what to change.

boverhof commented 5 years ago

I propose

examples/flowsheets/OUUByron/
examples/simulations/BFB/

fsoepyan commented 5 years ago

For the reorganization, I have an idea. Can we split the "examples" folder into 3 folders:

tutorial_files
test_files
other_files

In these 3 folders, we can have subfolders that says "ALAMO", "Heat_Integration", "Optimization", etc.

I can put the BFB file that I use for OUU in the "test_files/OUU_BFB" folder.

What do you think?

sotorrio1 commented 5 years ago

I like that idea. It would require some updates in the documentation to reflect the new paths, on LLNL side of things: /examples/tutorial_files/UQ /examples/tutorial_files/OUU /examples/tutorial_files/SDOE

ksbeattie commented 5 years ago

@fsoepyan will take a whack at this and open a PR with his proposed new org.

fsoepyan commented 5 years ago

I started on the reorganization, it is still a work in progress, but if you are interested, you can find it in my fork and branch: https://github.com/fsoepyan/FOQUS/tree/reorganization/examples

fsoepyan commented 5 years ago

In my fork and branch, I created 3 subfolders within FOQUS/examples:

tutorial_files
test_files
other_files

For FOQUS/examples/tutorial_files, I am naming the subfolders so that their names are the same as the chapters in the documentation (i.e., the user's manual).

Question: We no longer have the basic data tab. Do we want to keep the "Solvent Fit" chapter in the user's manual, or should we delete this chapter?

fsoepyan commented 5 years ago

So far, for the re-organization:

For the examples/other_files folder, I only have 1 dummy file (I created this file so that I can create the "other_files" subfolder).
For the examples/test_files folder, I have 1 subfolder that contains the 3 files for testing OUU in Remote Turbine.
For the examples/tutorial_files folder, I have placed contents for following tutorials:
[x] Flowsheets and Settings
[x] Optimization
[x] Uncertainty Quantification
[x] Optimization Under Uncertainty
[x] Surrogate Modeling
[x] SDOE
[x] Simulation Standard Interface (SimSinter)
[x] Heat Integration
[x] PYOMO-FOQUS

fsoepyan commented 5 years ago

Question:

Inside the original "examples" folder, we have the DRMBuilder and iREVEAL subfolders.
Because FOQUS no longer has these features, should we delete these subfolders from "examples", and transfer these contents to another folder?
I know there is an iRevealLite repository within CCSI Toolset.

fsoepyan commented 5 years ago

PR #574 should take care of the issue at least partially.