Skip to content

Commit 70edefb

Browse files
author
Jing Liu
committed
updated README.md
1 parent 234f965 commit 70edefb

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
According to <https://geant4.org>, Geant4 is a
66
> **Toolkit** for the simulation of the passage of particles through matter.
77
8-
which means that it is **NOT** a program that can be installed, double-clicked, and run.
8+
which means that it is **NOT** a program that can be double-clicked and run after installation.
99

1010
Instead, Geant4 is provided as a set of C++ libraries that need to be compiled [^1]. One must write a C++ program (Geant4 application) that calls functions provided in the compiled Geant4 libraries. The application itself also needs to be compiled, before it can be double-clicked and run.
1111

@@ -65,21 +65,23 @@ Fortunately, Geant4 also allows end users to write their detector definition in
6565

6666
Their difference is similar to that between [markdown][md] and [HTML][]. The detector definition in [plain text][tg] is the easiest to learn.
6767

68-
However, writing in a text file is not the most intuitive way to construct and debug 3D geometries. A graphic user interface (UI) is better suited for this task. [Shine][] is such a UI on the web. One can use the mouse to select, place, rotate basic shapes on a canvas, and export the constructed detector model to a [plain text file][tg] called `detector.tg`, which can be read by a Geant4 application.
68+
However, writing in a text file is not the most intuitive way to construct and debug 3D geometries. A graphic user interface (UI) is better suited for this task. [Shine][] is such a UI on the web. One can use the mouse to select, place, rotate basic shapes on a canvas, and export the constructed detector model to a [plain text file][tg] called `detector.tg`, which can be read by a Geant4 application that is configured to accept [detector definition in plain text format][tg].
6969

7070
![Shine: a Web UI for Geant4](https://lh3.googleusercontent.com/d/1IYnxORUysfgw7ymhGuH_jlVCUpe2lsd-)
7171

7272
### Geant4 Container
7373

7474
[![physino/geant4](https://img.shields.io/badge/physino-geant4-blue?style=flat)](https://hub.docker.com/r/physino/geant4)
7575

76-
The compilation of Geant4 C++ libraries and applications is a very challenging process for most end users who have limited experience on command-line user interface and C++ programming. The easiest way to bypass this challenge is to package both Geant4 libraries and some versatile applications into a single [container][] image that can be used in all operating systems without any modification.
76+
The [compilation][] of Geant4 C++ libraries and [application]s is a very challenging process for most end users who have limited experience on command-line user interface and C++ programming. The easiest way to bypass this challenge is to package both Geant4 libraries and some [versatile][universal] applications into a single [container][] image that can be used in all operating systems without any modification.
7777

78+
[compilation]: https://www.youtube.com/playlist?list=PLw3G-vTgPrdB9Nt2ekl2oL1yoqEC294Uf
7879
[container]: https://www.docker.com/resources/what-container
80+
[application]: https://www.youtube.com/playlist?list=PLw3G-vTgPrdD4Y1knA5nFUsZv4pfSVc-i
7981

80-
<https://hub.docker.com/r/physino/geant4> is such an image. It includes the [official Geant4 libraries pre-compiled on AlmaLinux 9](https://geant4.org/download) and two tiny [universial Geant4 applications], [GEARS][] and [MinGLE][], that accept the `detector.tg` file exported from [Shine][].
82+
<https://hub.docker.com/r/physino/geant4> is such an image. It includes the [official Geant4 libraries pre-compiled on AlmaLinux 9](https://geant4.org/download) and two tiny [universal] Geant4 applications, [GEARS][] and [MinGLE][], that accept the `detector.tg` file exported from [Shine][].
8183

82-
[universial Geant4 applications]: https://www.youtube.com/watch?v=3g9CkyBS31o
84+
[universal]: https://www.youtube.com/watch?v=3g9CkyBS31o
8385

8486
To use this image, we need to install [Docker Desktop][], a program that manages container images and containers. Please follow <https://youtu.be/RIBJ-2LsqsA> to get familiar with the program and the concept behind it.
8587

0 commit comments

Comments
 (0)