Documentation update

[vhirtham]

I just added a documentation how to create custom github repository for NuTo based applications including travis ci and codecov. This is already in our gitlab wiki.

Just to mention it: I added a link to the documentation on our github wiki. Hope that is okay.

[codecov[bot]]

Codecov Report

Merging #228 into PDE_reviewed will decrease coverage by 12.58%. The diff coverage is n/a.

@@                Coverage Diff                @@
##           PDE_reviewed     #228       +/-   ##
=================================================
- Coverage         84.16%   71.58%   -12.59%     
=================================================
  Files               295      521      +226     
  Lines             10617    19563     +8946     
=================================================
+ Hits               8936    14004     +5068     
- Misses             1681     5559     +3878

Flag	Coverage Δ
#integrationtests	51.72% <ø> (-9.77%)	:arrow_down:
#unittests	76.65% <ø> (-5.45%)	:arrow_down:

Impacted Files	Coverage Δ
test/visualize/VoronoiGeometries.cpp	100% <0%> (ø)	:arrow_up:
...ntegrationtests/mechanics/QuasistaticProblem1D.cpp	100% <0%> (ø)	:arrow_up:
test/visualize/TestStructure.h	100% <0%> (ø)	:arrow_up:
src/visualize/PointHandler.cpp	73.33% <0%> (ø)
...e/collision/collidables/CollidableParticleBase.cpp	100% <0%> (ø)
src/base/serializeStream/SerializeStreamBase.cpp	100% <0%> (ø)
...ics/interpolation/InterpolationTriangleQuadratic.h	100% <0%> (ø)
src/math/EigenIO.cpp	95.65% <0%> (ø)
...c/mechanics/tools/GlobalFractureEnergyIntegrator.h	100% <0%> (ø)
...ics/constitutive/damageLaws/DamageLawExponential.h	100% <0%> (ø)
... and 221 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update bef5a7e...90d6040. Read the comment docs.

[TTitscher]

This can certainly be useful for some people. (I personally prefer the make install way though. This automatically links Eigen, for example.) But I am not sure if that belongs to this repository. How about moving it to our wiki? Edit: I just realized, it already is in our wiki. Didn't properly read your comment, sorry.

[vhirtham]

Eigen is also "linked" by linking NuTo. You don't need to use the find package script. However, those two lines

find_path(EIGEN_INCLUDE_DIR NAMES Eigen/Core PATH_SUFFIXES eigen3)
include_directories(${EIGEN_INCLUDE_DIR})

reduce #include "Eigen/eigen3/..." to #include "eigen3/...". They are hidden somewhere in one of NuTos cmake scripts. Some of the NuTo headers use the shortened include version and therefore fail to compile if you don't have those to lines in your personal code too. Maybe we can get rid of those lines in NuTo?

I think the Guide should stay also in the documentation (maybe the user part, not the developers) since it gets non coding experts started really quick. Especially our "users". :stuck_out_tongue:

Maybe we should also move the NuTo part of gitlab wiki completly to the repository as I fiend it quiet annoying to have information about one topic spread across several places. We can also keep a link to the documentation there. But this might be another issue.

[vhirtham]

Well, personally I don't care if we put it into the doc or the wiki. The wiki has nicer code highlighting anyways :laughing: .

My question is: Who is our user? We always talk about the user to support our arguments, but we never decided who that is.

For me our current (future) users are basically ourselves. Most of the people who join our group, don't know much about c++ when they start and even less about all the other stuff we use (travis, docker etc.). So shouldn't the user documentation focus on them?

I totally agree, that this article might not belong to the documentation itself, since a documentation is meant to just explain the current installation procedure, functionality and interfaces but if we are that strict there is probably more that should be moved to the wiki.

However, as I said before, I don't like it if information regarding a single topic (NuTo) is spread across several places. But thats my personal point of view.

@Psirus: Thanks for all the comments and actually bothering to read all of it.

EDIT: I updated the wiki with all your comments. Didn't do that for the documentation, as long as we have not decided whether to put it inside the doc or not.

[vhirtham]

Okay, since there is no further progress here and keeping the wiki and the documentation up to date is additional work, I just close this pull request.