Dear Axel,
welcome to the mailing list. Feedback regarding the beginner material is always
welcome.
Also improvements to the beginner material and docs are welcome of course.
Please consider two things:
1) We want to avoid duplicate resources to reduce maintenance effort regarding
docs. The idea is that users first come in contact with DuMux from the website
and follow the getting started guide.
If there is some information there that is missing in the course, it would be
good to mention at the beginning of the Basics scenario that we expect that
_before_ starting the course scenario,
the user should have a look at the website (providing a link to the getting
started guide).
2) If more information regarding the initial configuration/setup is missing,
your improvement to the Basics scenario is highly welcome.
However, one more thing: I’m not sure what you exactly mean by “installation".
Nothing needs to be installed (in the C++ tooling sense) to do the course.
You need to download the source files and then configure (CMake/dunecontrol)
and build (compile) the Dune modules + Dumux libraries and then maybe build
(compile) your specific application.
Installation (with “make install”) is not necessary and is I think not
discussed in the current course.
Sources > configure > compile (> install) is the usual way of working with C++
packages when using source files and not binaries (or header-only libraries).
(We don’t currently provide binaries for Dumux but the Dune core modules and
some other modules provide Debian packages. Since packages don’t exist for all
modules often used with Dumux we don’t currently recommend this way of
installation.)
The configure/compilation part for a modular Dune project is slightly
simplified with the helper script “dunecontrol” so that you don’t have to
manually do the "configure > compile" sequence for every module.
In case this information was missing for you, it is of course also a good
addition to the course material.
I hope this clarifies some things and helps you in improving the docs. Thanks
for considering Dumux.
Let us know if you have any questions regarding the contribution workflow
(https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/-/blob/master/CONTRIBUTING.md)
Best wishes
Timo
> On 13. Jan 2022, at 14:10, Axel Schumacher
> wrote:
>
> Dear Sir or Madam,
>
> in the context of the lecture Simulation Software Engineering at the
> University of Stuttgart I am supposed to make a contribution to DuMuX.
> While installing the software and trying out the first tutorials, I noticed
> that, contrary to my expectations, the contents of the DuMuX course have to
> be installed and not just downloaded.
> In retrospect, I also found information about this on the homepage, directly
> when trying it out, it was unintuitive for me.
> Therefore I would like to add the installation of the DuMuX course as the
> first part of the description of the scenario "Basics". This would give other
> users one less pitfall to overcome in order to use the software. But before I
> open a pull request, I wanted to ask here if this suggestion is gladly
> accepted or not.
> I am looking forward to a reply and a good cooperation.
>
> Kind regards
> Axel Schumacher
>
> ___
> DuMux mailing list
> DuMux@listserv.uni-stuttgart.de
> https://listserv.uni-stuttgart.de/mailman/listinfo/dumux
___
DuMux mailing list
DuMux@listserv.uni-stuttgart.de
https://listserv.uni-stuttgart.de/mailman/listinfo/dumux
