Skip to content

Commit 2a3cb37

Browse files
maureeungaromaureeungaro
committed
help improvements
1 parent b376210 commit 2a3cb37

8 files changed

Lines changed: 66 additions & 36 deletions

File tree

‎README.md‎

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,58 @@
1111
<br/>
1212

1313

14-
## Build And Test Status
14+
## Continuous Integration
1515

16+
### Platforms
1617

18+
| OS | version | architecture |
19+
|:----------|---------:|--------------:|
20+
| ubuntu | 24.04 | amd64, arm64 |
21+
| fedora | 40 | amd64, arm64 |
22+
| almalinux | 9.4 | amd64, arm64 |
23+
| debian | 12 | amd64, arm64 |
24+
| archlinux | 12 | amd64 |
1725

18-
| | version | architecture |
19-
|:-----------|---------:|--------------:|
20-
| ubuntu | 24.04 | amd64, arm64 |
21-
| fedora | 40 | amd64, arm64 |
22-
| almalinux | 9.4 | amd64, arm64 |
23-
| debian | 12 | amd64, arm64 |
24-
| archlinux | 12 | amd64 |
2526

27+
### Deployment
2628

27-
[![Build And Test Images](https://github.com/gemc/src/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/gemc/src/actions/workflows/build_and_test.yml)
29+
[![CI][CI-badge]][CI]
2830

31+
[![Docs][Docs-badge]][Docs]
2932

30-
## Metrics
3133

32-
[![Sanitize](https://github.com/gemc/src/actions/workflows/sanitize.yaml/badge.svg)](https://github.com/gemc/src/actions/workflows/sanitize.yaml)
34+
[![Site][Site-badge]][Site]
3335

34-
[![CodeQL Advanced](https://github.com/gemc/src/actions/workflows/codeql.yml/badge.svg)](https://github.com/gemc/src/actions/workflows/codeql.yml)
36+
3537

36-
### Nightly
3738

38-
[![Nightly Dev Release](https://github.com/gemc/src/actions/workflows/dev_release.yml/badge.svg)](https://github.com/gemc/src/actions/workflows/dev_release.yml)
39-
[![Doxygen](https://github.com/gemc/src/actions/workflows/doxygen.yaml/badge.svg)](https://github.com/gemc/src/actions/workflows/doxygen.yaml)
39+
[CI]: https://github.com/gemc/src/actions/workflows/dockers_deploy_and_test.yml
40+
[CI-badge]: https://github.com/gemc/src/actions/workflows/dockers_deploy_and_test.yml/badge.svg
41+
42+
43+
[Docs]: https://github.com/gemc/src/actions/workflows/doxygen.yml
44+
[Docs-badge]: https://github.com/gemc/src/actions/workflows/doxygen.yml/badge.svg
45+
46+
[Nightly]: https://github.com/gemc/src/actions/workflows/dev_release.yml
47+
[Nightly-badge]: https://github.com/gemc/src/actions/workflows/dev_release.yml/badge.svg
48+
49+
[Site]: https://github.com/gemc/home/actions/workflows/jekyll.yml
50+
[Site-badge]: https://github.com/gemc/home/actions/workflows/jekyll.yml/badge.svg
51+
52+
[Sanitize]: ttps://github.com/gemc/src/actions/workflows/sanitize.yml
53+
[Sanitize-badge]: https://github.com/gemc/src/actions/workflows/sanitize.yml/badge.svg
54+
55+
[CodeQL]: https://github.com/gemc/src/actions/workflows/codeql.yml
56+
[CodeQL-badge]: https://github.com/gemc/src/actions/workflows/codeql.yml/badge.svg
57+
58+
59+
60+
### Metrics
61+
62+
[![Sanitize][Sanitize-badge]][Sanitize]
63+
64+
[![CodeQL][CodeQL-badge]][CodeQL]
65+
66+
### Nightly
4067

68+
[![Nightly][Nightly-badge]][Nightly]

‎api/gconfiguration.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ def get_arguments(argv=None):
5555
parser.add_argument("-r", "--run", default=1, help="Set run number")
5656
parser.add_argument("-sql", "--dbhost", default='gemc.db', help="SQLite filename or MYSQL host")
5757
# pyvista
58-
parser.add_argument("-pv", "--pyvista", action="store_true", help="Show geometry using pyvista")
58+
parser.add_argument("-pv", "--pyvista", action="store_true", help="Show geometry using pyvista (needs pyvista)")
5959
parser.add_argument(
6060
"-pvb", "--pvb", "--pyvista-background",
6161
dest="pyvista_background",
6262
action="store_true",
63-
help="Use PyVista BackgroundPlotter (non-blocking GUI, implies --pyvista)",
63+
help="Use PyVista BackgroundPlotter (non-blocking GUI, needs pyqt6 pyvistaqt)",
6464
)
6565
parser.add_argument("-pvw", "--width", type=int, default=2400, help="Set plotter width")
6666
parser.add_argument("-pvh", "--height", type=int, default=1600, help="Set plotter height")

‎examples/basic/b1/b1.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
experiment: examples
22
runno: 1
3-
n: 500
3+
n: 10
44
nthreads: 4
55

66
gparticle:

‎gdynamicDigitization/gParticleCounterDigitization.cc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ std::unique_ptr<GDigitizedData> GParticleCounterDigitization::digitizeHitImpl(GH
1919

2020
auto gdata = std::make_unique<GDigitizedData>(gopts, ghit);
2121

22-
gdata->includeVariable(identity.getName(), identity.getValue());
2322
gdata->includeVariable("hitn", static_cast<int>(hitn));
2423
gdata->includeVariable("totEdep", ghit->getTotalEnergyDeposited());
2524
gdata->includeVariable("time", ghit->getAverageTime());

‎gparticle/gparticle_options.cc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ GOptions defineOptions() {
6565
help += "The particle is generated with a fixed or randomized momentum, angles, and vertex. \n \n";
6666
help += "Examples: \n";
6767
help += "• 5 GeV electron along z: \n";
68-
help += "-gparticle=\"[{pname: e-, p: 5000}]\" \n \n";
68+
help += "-gparticle=\"[{name: e-, p: 5000}]\" \n \n";
6969
help += "• three particles, one electron and two protons, identical except spread in theta: \n \n";
7070
help +=
7171
"-gparticle=\"[{name: e-, p: 2300, theta: 23.0}, {name: proton, multiplicity: 2, p: 1200, theta: 14.0, delta_theta: 10}]\"\n";

‎gparticle/meson.build‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
sub_dir_name = meson.current_source_dir().split('/').get(-1)
22
internal_deps = ['goptions', 'guts', 'glogging']
33

4-
single = [ '-gparticle="[{name: e-, p: 2300, theta: 23.0}]"']
4+
single = ['-gparticle="[{name: e-, p: 2300, theta: 23.0}]"']
55
double = ['-gparticle="[{name: e-, p: 2300, theta: 23.0}, {name: proton, multiplicity: 2, p: 1200, theta: 14.0, delta_theta: 10}]"']
66

77
example_source = files('examples/gparticle_example.cc')

‎gstreamer/gstreamer_options.cc‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,20 +43,22 @@ GOptions defineOptions() {
4343

4444
// User-facing CLI help for the -gstreamer structured option.
4545
// The file extension is added automatically by the selected plugin.
46-
string help = "Define a Output format and name\n";
47-
help += "This option defines a GStreamer output. It can be used to write events or frame streams.\n";
48-
help += "\n";
49-
help += "The file extension is added automatically based on the format.\n";
50-
help += "Supported formats:\n";
51-
for (auto& format : GStreamer::supported_formats()) { help += " - " + format + "\n"; }
52-
help += "\n";
53-
help += "Output types\n";
46+
string help = "Define output formats and filenames. It can be used to select <events> or <frame> streams.\n";
47+
help += "The file extension is added automatically based on the format.\n \n";
48+
help += "\nSupported formats:\n \n";
49+
for (auto& format : GStreamer::supported_formats()) { help += " - " + format + "\n"; }
50+
help += "\n \n";
51+
help += "Output types:\n \n";
5452
help += "\n";
5553
help += " - event: write events\n";
56-
help += " - stream: write frame stream\n";
57-
help += "\n";
58-
help += "Example that defines two gstreamer outputs:\n";
59-
help += "-gstreamer=\"[{format: root, filename: out}, {format: jlabsro, filename: out}}]\"\n";
54+
help += " - stream: write frame time snapshots\n";
55+
help += "\n \n";
56+
help += "Example that defines two gstreamer outputs:\n \n";
57+
help += " -gstreamer=\"[{format: root, filename: out}, {format: csv, filename: out}]\"\n";
58+
help += "\n \n";
59+
help += "The produced files structure depends on the accumulation method used: \n \n";
60+
help += " - event-based digitization (like <flux>) will have one file for every thread, with \"_tj\" appended to the filename \n";
61+
help += " - run-based digitization (like <dosimeter>) will have one file only\n";
6062

6163
// Buffer flush limit:
6264
// controls how many events each streamer instance may retain in memory
@@ -66,8 +68,8 @@ GOptions defineOptions() {
6668

6769
// Schema of each object in the -gstreamer array.
6870
vector<GVariable> gstreamer = {
69-
{"filename", goptions::NODFLT, "name of output file"},
70-
{"format", goptions::NODFLT, "format of output file"},
71+
{"filename", goptions::NODFLT, "name of output file. "},
72+
{"format", goptions::NODFLT, "format of output file. "},
7173
{"type", "event", "type of output file"},
7274
};
7375

‎utilities/gemcUtilities.cc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@ namespace gemc {
118118
cmds.emplace_back("/vis/scene/endOfEventAction accumulate 10000");
119119

120120
// Background colors and root volume are the same.
121-
cmds.push_back("/vis/viewer/set/background 0.46666667 0.53333333 0.6");
121+
// Chosen to be the same as pyvistab for now
122+
cmds.push_back("/vis/viewer/set/background 0.05 0.05 0.26");
122123

123124
// Re-enable refresh and flush once configuration is complete.
124125
cmds.emplace_back("/vis/viewer/set/autoRefresh true");

0 commit comments

Comments
 (0)