diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c30f2bc..12aac67 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -39,7 +39,6 @@ repos: hooks: - id: prettier types_or: [yaml, markdown, html, css, scss, javascript, json] - args: [--prose-wrap=always] - repo: https://github.com/astral-sh/ruff-pre-commit rev: "v0.8.4" diff --git a/docs/developer.md b/docs/developer.md index 596ef71..0be3fd0 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -116,8 +116,9 @@ $ ctest -R basics-mt/print-volumes.mac # run only this test ::: -:::{tip} If you want to open a fancy UI to check the output of `vis` tests, you -may achieve it by: +:::{tip} +If you want to open a fancy UI to check the output of `vis` tests, you may +achieve it by: 1. `cd` to `test/confinement` 1. edit `macros/_vis.mac` to make sure you load an interactive UI (e.g. @@ -125,7 +126,8 @@ may achieve it by: 1. edit the macro you are interested in and swap `_init.mac` with `_vis.mac` at the very beginning (after `/control/execute`) 1. run the visualization with - `remage -i -g gdml/geometry.gdml -- macros/themacro.mac` ::: + `remage -i -g gdml/geometry.gdml -- macros/themacro.mac` + ::: ### Configuring CMake diff --git a/docs/tutorial.md b/docs/tutorial.md index 0151795..a9882b6 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -191,7 +191,8 @@ radioactive source: /run/beamOn 50 ``` -:::{admonition} Complete macro file (`vis-gammas.mac`) :class: dropdown +:::{admonition} Complete macro file (`vis-gammas.mac`) +:class: dropdown ```text /RMG/Manager/Logging/LogLevel detail @@ -245,15 +246,18 @@ $ remage --interactive --gdml-files geometry.gdml -- vis-gammas.mac ... ``` -:::{note} Interactive visualization requires passing `--interactive` to the -`remage` executable. ::: +:::{note} +Interactive visualization requires passing `--interactive` to the +`remage` executable. +::: Interactions in HPGes and in LAr are marked in red and blue, respectively. ![Simulation visualization](img/tutorial-g4-view.jpg) -:::{tip} With Apptainer, additional tweaks are required in order to allow for -graphics to be displayed, e.g. +:::{tip} +With Apptainer, additional tweaks are required in order to allow for graphics +to be displayed, e.g. ```console $ apptainer run \ @@ -264,11 +268,14 @@ $ apptainer run \ path/to/remage_latest.sif --interactive [...] ``` -and similarly with Docker. ::: +and similarly with Docker. +::: -:::{tip} If `remage` from the Apptainer image refuses to run simulations, this -might be due to some of your environment variables from outside the container. -Give `--cleanenv` a try. ::: +:::{tip} +If `remage` from the Apptainer image refuses to run simulations, this might be +due to some of your environment variables from outside the container. Give +`--cleanenv` a try. +::: ## Storing simulated data on disk