Skip to content
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.

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

Documentation: Tutorials #57

Merged
merged 21 commits into from
Apr 24, 2024
Merged

Documentation: Tutorials #57

merged 21 commits into from
Apr 24, 2024

Conversation

schuettem
Copy link
Collaborator

Copy Tutorials from old Docu into new Docu

@schuettem schuettem added the documentation Improvements or additions to documentation label Feb 15, 2024
@schuettem schuettem self-assigned this Feb 15, 2024
@scopplestone
Copy link
Collaborator

The large image files should be reduced in size (and removed from the history) and re-committed.

@schuettem
Copy link
Collaborator Author

I reduced some of the large images. The largest image is now 367,2 kB. Is this still too large or ok? These changes are not committed yet, because I don't know how to remove a file from the git history.

@scopplestone
Copy link
Collaborator

367,2 kB should be O.K.

You can fix the history by, e.g., over-writing the last commit (which is okay if you are the only one working on the branch)

git add path/to/my/changed/file
git commit --amend --date=now
git push --force-with-lease origin improvement.documentation

This will destroy the previous commit hash and generate a new one.

@schuettem schuettem force-pushed the improvement.documentation branch from 3e1c0ff to 23705e8 Compare February 16, 2024 07:05
@kopperp kopperp force-pushed the improvement.documentation branch from 8b65fa5 to 7333ad8 Compare March 12, 2024 10:41
@kopperp kopperp force-pushed the improvement.documentation branch from 7333ad8 to a4948bb Compare March 12, 2024 12:23
@kopperp
Copy link
Collaborator

kopperp commented Mar 25, 2024

The uploaded version is a good first draft, but still needs some work with shortening, sanity checking and proof-reading. To distribute this work, please pick one of the following list by editing this post:

Status Person File
Done Patrick blockstructuredmeshes.md
Done Patrick index_inbuiltmeshgenerators.md
Done Patrick straightedgedboxes.md
Done Paul curvedmeshes.md
Done Stephen externalmesheswithcurvedboundaries.md
Done Stephen externalmesheswithoutcurvedboundaries.md
Done Miklas generationofhexahedralmeshes.md
Done Stephen hoproutputparameter.md
Done Marcel index_agglomeration.md
Done Marcel index_externalmeshes.md
Done Marcel index_postprocessing.md
Done Marcel index_visualization.md
Done Franziska meshrefinement.md
Done Claudia meshuncurving.md
Done Raphael visualizationwithparaview.md
Done Paul userguide/parameters.md

@tietz-r
Copy link
Collaborator

tietz-r commented Apr 22, 2024

I read the visualization with paraview file. There is a mention to a custom filter which you can import, but I cannot find this filter anywhere. Do you know, where it is otherwise I would delete the corresponding section...

Edit: I removed this part of the doku

@scopplestone scopplestone marked this pull request as ready for review April 24, 2024 15:21
@scopplestone scopplestone merged commit 8ebc5ac into master Apr 24, 2024
2 checks passed
@scopplestone scopplestone deleted the improvement.documentation branch April 24, 2024 15:22
@kopperp
Copy link
Collaborator

kopperp commented Apr 27, 2024

I read the visualization with paraview file. There is a mention to a custom filter which you can import, but I cannot find this filter anywhere. Do you know, where it is otherwise I would delete the corresponding section...

I think that reference was actually to the FLEXI ParaView-Plugin which effectively wraps the posti_visu/piclas2vtk runtime and writes the output directly into ParaView's memory. A bit more detail is given in the FLEXI documentation but I fully agree that this section does not belong in the HOPR documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants