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.

Sign up for GitHub

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

Jump to bottom

Update documentation #145

Merged
merged 10 commits into from
Nov 7, 2024
Merged

Update documentation #145

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
027783c
[docs] remove development warning in README
gipert Nov 5, 2024
f19df43
[docs] update remage docker hub link
gipert Nov 5, 2024
ea4f6e5
[docs] fix Docker Hub org name
gipert Nov 5, 2024
9654fb9
[docs] fix cmake config of docs source files
gipert Nov 5, 2024
1a4e65f
[docs] add some notes on how to generate docs locally
gipert Nov 5, 2024
6824331
Make scintillation detector hits blue
gipert Nov 5, 2024
e839f14
[docs] let CMake also handle image sources
gipert Nov 5, 2024
c53bedb
[docs} started with the tutorial
gipert Nov 5, 2024
4b0f853
[docs] a bunch of fixes
gipert Nov 6, 2024
9dc3c9c
[docs] add output part to tutorial
gipert Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ setup (supported specification languages are C++, GDML and more). The user can
then benefit from a predefined set of tools to perform common actions (physics
generators, standard output classes, etc).

> [!WARNING]
> *remage* is still under heavy development. Users are advised to use a tagged
> release for any workloads unrelated to remage development, if possible.

### Main features

* Support for modern [Geant4](https://geant4.web.cern.ch), including
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ Pre-built binaries

The recommended and fastest way of running |remage| is through pre-built
software containers. Stable releases are regularly made available `on Docker
Hub <https://hub.docker.com/repository/docker/gipert/remage>`_. To obtain and
Hub <https://hub.docker.com/repository/docker/legendexp/remage>`_. To obtain and
run the latest just do:

.. code-block:: console

$ docker run gipert/remage --help # just prints a help message
$ docker run legendexp/remage:latest --help # just prints a help message

If you prefer `Apptainer <https://apptainer.org/>`_, you can easily generate an image locally:

.. code-block:: console

$ apptainer build remage_latest.sif docker://gipert/remage:latest
$ apptainer build remage_latest.sif docker://legendexp/remage:latest
$ apptainer run remage_latest.sif --help

If containers do not work for you, see the next section to learn how to build
Expand Down