Add capability to handle interdependent functions in samplers/optimizers

alfoa commented 1 month ago

Pull Request Description

What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)

Closes #2302

What are the significant changes in functionality due to this change request?

Added the possibility to specify in Optimizers/Samplers variables (defined through functions) that are interdependent.

For example, lets assume we sample the variables

#_Eggs,
grams_Pancetta_or_Guanciale(I know we should use only guanciale but it is difficult to find it),
grams_Pecorino_Cheese;
#_tomatos;

the variable what_dish_do_we_cook depends solely on these variables (and it is defined through a RAVEN <function>) and depending on the values of #_tomatos and #_Eggs the result of this function can be either be Carbonara or Amatriciana.

the variable which_pasta_should_we_use depends on the variable what_dish_do_we_cook: if

what_dish_do_we_cook == Carbonara, which_pasta_should_we_use == Rigatoni else
what_dish_do_we_cook == Amatriciana, which_pasta_should_we_use == Bucatini

Based on this example, RAVEN will first sample #_Eggs, grams_Pancetta_or_Guanciale, grams_Pecorino_Cheese and #_tomatos; Then it evaluates the function that computes the variable what_dish_do_we_cook and finally it computes the variable which_pasta_should_we_use depending on the value of the variable what_dish_do_we_cook.

In addition to this capability, also a new test for the ensemble model testing/showing how to use it to transfer string variables from a model to the other using RAVEN variables has been added.

For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

[x] 1. Review all computer code.
[x] 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
[x] 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
[x] 4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
[x] 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
[x] 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
[x] 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
[x] 8. If an analytic test is changed/added is the the analytic documentation updated/added?
[x] 9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

alfoa commented 1 month ago

@wangcj05 @joshua-cogliati-inl @mandd

Unfortunately new issue

... Activating environment ...
... Installing libraries from PIP-ONLY ...
...pip-only command: pip install netcdf4==1.6.* tensorflow==2.13.* grpcio dask[complete] ray[default]==2.6.* imageio==2.22.* python-sensors numdifftools==0.9.* xmlschema fmpy==0.3.16.*
WARNING: Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfab2cb0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=3, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfc26bc0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=2, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfc25ab0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=1, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfc26080>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
WARNING: Retrying (Retry(total=0, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<pip._vendor.urllib3.connection.HTTPSConnection object at 0x7f54cfab30d0>: Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/netcdf4/
ERROR: Could not find a version that satisfies the requirement netcdf4==1.6.* (from versions: none)
ERROR: No matching distribution found for netcdf4==1.6.*

ERROR: exiting with code 1