You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
calls make on the (already built?) macro-dumux and micro-dumux modules
moves the built binaries to the respective case directories
In the rest of the tutorials, we don't provide such scripts. For example:
For deal.II cases (see perpendicular-flap and run-dealii.sh), we ask the user to install deal.II and the deal.II adapter. If these are not found, we inform the user.
In the Quickstart, we ask the user to install all the dependencies, hinting them how to do that.
There are multiple reasons to do this like this:
Such scripts tend to be very system-specific. Already the line mv micro-dumux/build-cmake/appl/micro_sim.cpython-310-x86_64-linux-gnu.so micro-dumux/ demonstrates that.
If such a script fails, then the user is clueless and can only blame preCICE (us).
Such scripts might conflict with our documentation on how to install the respective adapters. For example, I already built the DuMuX adapter in the home directory of the VM, but now I am asked to repeat such an installation in a local folder.
We have to maintain such scripts.
I think we can improve the situation here:
Inform the user what the dependencies are
Inform the user that the solvers need to be built
Describe how to build these using a given DuMuX adapter installation
We can still provide some helper scripts, but I would rather not. Instead, I would focus on demonstrating in some CI workflow file / Dockerfile what steps to take to run the tutorial. This could be demonstrated in the system tests, or in the CI of the micro-manager.
In the two-scale-heat-conduction tutorial, we currently have:
macro_dumux
and the micro-manager.dumux-phasefield
, as well as the external dependencyspgrid
make
on the (already built?)macro-dumux
andmicro-dumux
modulesIn the rest of the tutorials, we don't provide such scripts. For example:
There are multiple reasons to do this like this:
mv micro-dumux/build-cmake/appl/micro_sim.cpython-310-x86_64-linux-gnu.so micro-dumux/
demonstrates that.I think we can improve the situation here:
We can still provide some helper scripts, but I would rather not. Instead, I would focus on demonstrating in some CI workflow file / Dockerfile what steps to take to run the tutorial. This could be demonstrated in the system tests, or in the CI of the micro-manager.
cc @IshaanDesai @Fujikawas
The text was updated successfully, but these errors were encountered: