Skip to content

Commit

Permalink
Fix problem with prettier destroying :::{}:::
Browse files Browse the repository at this point in the history
  • Loading branch information
gipert committed Dec 31, 2024
1 parent 9d256d0 commit 3b88572
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 13 deletions.
1 change: 0 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
8 changes: 5 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ _remage_ is a modern C++ simulation framework for germanium experiments.

The installation process is documented in {doc}`install`.

:::{warning} A proper user guide is not available yet. In the meanwhile, users
can have a look at the {doc}`tutorial` or the provided
[examples](https://github.com/legend-exp/remage/tree/main/examples). :::
:::{warning}
A proper user guide is not available yet. In the meanwhile, users can have a
look at the {doc}`tutorial` or the provided
[examples](https://github.com/legend-exp/remage/tree/main/examples).
:::

In the simplest application, the user can simulate in an existing GDML geometry
through the `remage` executable:
Expand Down
25 changes: 16 additions & 9 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 \
Expand All @@ -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

Expand Down

0 comments on commit 3b88572

Please sign in to comment.