Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
KM3io.jl
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
common
KM3io.jl
Commits
2823199e
Verified
Commit
2823199e
authored
1 year ago
by
Tamas Gal
Browse files
Options
Downloads
Patches
Plain Diff
Update docs on detx/datx
parent
598e04c0
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+1
-1
1 addition, 1 deletion
README.md
docs/src/manual/detector.md
+8
-10
8 additions, 10 deletions
docs/src/manual/detector.md
with
9 additions
and
11 deletions
README.md
+
1
−
1
View file @
2823199e
...
...
@@ -8,7 +8,7 @@
`KM3io.jl`
is a Julia library which implements high-performance I/O functions
and additional utilities to deal with dataformats used in KM3NeT, e.g.
[
ROOT
](
https://root.cern.ch
)
(
online/offline
files),
[
DETX
](
https://wiki.km3net.de/index.php/Dataformats#Detector_Description_.28.detx_and_.datx.29
)
[
DETX
/DATX
](
https://wiki.km3net.de/index.php/Dataformats#Detector_Description_.28.detx_and_.datx.29
)
(detector geometry and calibrations) and acoustics (waveforms and hardware). In
contrast to Python, you are free to utilise as many (nested)
`for`
-loops as you
like while still being as fast as in e.g. in C++.
...
...
This diff is collapsed.
Click to expand it.
docs/src/manual/detector.md
+
8
−
10
View file @
2823199e
...
...
@@ -3,12 +3,9 @@
In this example, we will explore the components of a KM3NeT detector, which is
represented by the
[
`Detector`
](
@ref
)
type in
`KM3io.jl`
. The detector
description is stored in so-called
[
`DETX`-files
](
https://wiki.km3net.de/index.php/Dataformats#Detector_Description_.28.detx_and_.datx.29
)
,
named after its filename extension
`.detx`
). It's an ASCII-based file format and
by the time of writing this example,
`v5`
is the latest format version. There is
a yet unofficial binary version of this format named
`DATX`
(with the filename
extension
`datx`
), which is currently not supported, neither widely used in
KM3NeT.
[
`DETX` and `DATX` files
](
https://wiki.km3net.de/index.php/Dataformats#Detector_Description_.28.detx_and_.datx.29
)
,
named after their filename extensions
`.detx`
(ASCII) and
`.datx`
(binary) respectively.
By time of writing this example,
`v5`
is the latest format version.
!!! note
...
...
@@ -21,11 +18,12 @@ KM3NeT.
point of the PMT axes. Otherwise, these parameters are either set to meaningful
default values or to `missing`.
## Loading a `DETX` File
## Loading a `DETX
/DATX
` File
The
[
`Detector`
](
@ref
)
type offers a constructor which takes a filepath to a
`DETX`
file. The
[
KM3NeTTestData.jl
](
https://git.km3net.de/km3py/km3net-testdata
)
offers a collection of detector sample files, so let's pick one of them:
The
[
`Detector`
](
@ref
)
type has a constructor which takes a filepath to a
`DETX`
or
`DATX`
file. The
[
KM3NeTTestData.jl
](
https://git.km3net.de/km3py/km3net-testdata
)
offers a
collection of detector sample files, so let's pick one of them:
```
@example 1
using KM3io, KM3NeTTestData
...
...
This diff is collapsed.
Click to expand it.
Tamas Gal
@tgal
mentioned in commit
f51c54b8
·
1 year ago
mentioned in commit
f51c54b8
mentioned in commit f51c54b8985da3dda84826f859c99c1b648ae2fb
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment