Skip to content

Ensure Forcing Cleanup Routine on NGEN Failure (NGWPC-10147) #169

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

Open
idtodd wants to merge 2 commits into
base: development
Choose a base branch
from
Open

Ensure Forcing Cleanup Routine on NGEN Failure (NGWPC-10147) #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a65308
Destroy python interpreter when run_ngen throws an error
idtodd Apr 10, 2026
6f531d4
Remove unneeded calls to InterpreterUtil::getInstance() to ensure mai…
idtodd Apr 10, 2026
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
34 changes: 17 additions & 17 deletions src/NGen.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,15 +203,6 @@ int run_ngen(int argc, char* argv[], int mpi_num_procs, int mpi_rank) {
ss.str("");
std::ios::sync_with_stdio(false);

#if NGEN_WITH_PYTHON
// Start Python interpreter via the manager singleton
// Need to bind to a variable so that the underlying reference count
// is incremented, this essentially becomes the global reference to keep
// the interpreter alive till the end of `main`
auto _interp = utils::ngenPy::InterpreterUtil::getInstance();
// utils::ngenPy::InterpreterUtil::getInstance();
#endif // NGEN_WITH_PYTHON

// Pull a few "options" form the cli input, this is a temporary solution to CLI parsing!
// Use "positional args"
// arg 0 is program name
Expand Down Expand Up @@ -819,6 +810,8 @@ int main(int argc, char* argv[]) {
int mpi_num_procs = 1;
// Define in the non-MPI case so that we don't need to conditionally compile `if (mpi_rank == 0)`
int mpi_rank = 0;
// exit code result of the simulation run
int result;

#if NGEN_WITH_MPI
// initialize MPI if needed
Expand All @@ -832,15 +825,22 @@ int main(int argc, char* argv[]) {
// Need to bind to a variable so that the underlying reference count
// is incremented, this essentially becomes the global reference to keep
// the interpreter alive till the end of `main`
auto _interp = utils::ngenPy::InterpreterUtil::getInstance();
#endif // NGEN_WITH_PYTHON

int result = run_ngen(argc, argv, mpi_num_procs, mpi_rank);

#if NGEN_WITH_PYTHON
auto interp = utils::ngenPy::InterpreterUtil::getInstance();
try {
result = run_ngen(argc, argv, mpi_num_procs, mpi_rank);
} catch (...) {
// If any uncaught exception happens,
// explictly destroy the interpreter to ensure any
// python atexit registered actions will trigger.
interp.reset();
// Then, throw the original error.
throw;
}
// explicitly destroy the interpreter before calling MPI_Finalize
_interp.reset();
#endif
interp.reset();
#else
result = run_ngen(argc, argv, mpi_num_procs, mpi_rank);
#endif // NGEN_WITH_PYTHON

#if NGEN_WITH_MPI
MPI_Finalize();
Expand Down
3 changes: 1 addition & 2 deletions src/forcing/ForcingsEngineDataProvider.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,8 @@ void assert_forcings_engine_requirements()
{
// Check that the python module is installed.
{
auto interpreter_ = utils::ngenPy::InterpreterUtil::getInstance();
try {
auto mod = interpreter_->getModule(forcings_engine_python_module);
auto mod = utils::ngenPy::InterpreterUtil::getPyModule(forcings_engine_python_module);
auto cls = mod.attr(forcings_engine_python_class).cast<py::object>();
} catch(std::exception& e) {
std::string msg = "Failed to initialize ForcingsEngine: ForcingsEngine python module is not installed or is not properly configured. (" +
Expand Down
Loading