Logo

Getting started

  • Installation and requirements
    • Requirements
    • Installation
      • Does pip work?
      • Docker
    • Verifying the installation
  • Quick start guide
    • Terms used on this page
    • Your first voltage
    • Reading the result
    • Switching stages off
    • Digitizing
    • Positions
    • Where next
  • Tutorial: one shower, start to finish
    • 1. The shower
    • 2. Voltages at the antennas
    • 3. ADC counts
    • 4. The trigger
    • 5. Signal, noise and peak times
    • 6. The arrival direction
    • 7. The footprint
    • Where next
  • Cheat sheet
    • Units
    • Conventions
    • Files
    • Common calls
    • When something looks wrong
  • Recipes
    • Every event of a folder
    • All the trees of a folder
    • Many files without memory growth
    • The antennas in latitude and longitude
    • The geomagnetic field and the geoid at a site
    • The RF chain’s response
    • Galactic noise at a sidereal time
    • The T1 trigger
    • The arrival direction from peak times
    • Where next
  • Tutorial notebooks
    • The notebooks
    • Where next
  • The examples folder
    • By task
    • What does not run
    • Where next

Analyzing data

  • Working with measured data
    • What a measured file holds
    • Getting the data
    • Opening a file
    • Channels
    • From counts to volts
    • Times
    • Positions
    • Which trigger recorded the event
    • From events to a reconstruction
    • To confirm
    • Where next
  • The data model
    • The naming convention
    • The classes
    • Read one event
    • Provenance
    • Reading many files: release each tree
    • How the tree classes work
    • Reference
    • Where next
  • Coordinates and conventions
    • The frames
    • Converting between them
      • Frames are NumPy arrays
    • GRANDCS and LTP axes differ
    • Orientation strings
    • Heights need a reference
    • Angles are in degrees
    • A shower’s angles say where it comes from
    • Common mistakes
    • Reference
    • Where next
  • Sites and detector layouts
    • Where a file keeps its positions
    • Sites in the repository
    • Layout files
    • From latitude and longitude to the array frame
    • Generating a layout
    • Where next
  • Writing your own files
    • The run: where the antennas are
    • The events
    • Reading it back
    • File names
    • Closing files
    • Where next

Running simulations

  • Producing simulations
    • The steps
    • 1. ZHAireS input files
      • Many showers
    • 2. To RawROOT
    • 3. To voltages and ADC counts
    • Measured noise instead of simulated noise
    • Checking the result
    • Where next
  • Converting simulations: sim2root
    • Where it sits
    • Running it
    • Where next
  • Command-line tools
    • The whole chain
      • Where outputs go
    • convert_efield2voltage.py
    • convert_voltage2adc.py
    • convert_efield2efield.py
    • extract_events.py
    • Other scripts
    • Where next
  • Running at scale
    • One folder per job
    • What a job needs
    • A SLURM job array
    • On a workstation
    • Reading many files in one analysis
    • The production pipeline for measured data
    • Where next
  • The simulation chain
    • The stages
    • Open-circuit voltage
    • Galactic noise
    • The RF chain
    • Digitization
    • Performance
    • What is not modeled
  • Validation
    • Galactic noise against the tables
    • The direction of a shower
    • Which arm is which
    • Reconstructing a known direction
    • Properties that hold exactly
    • Regression checks
    • Where next

When something goes wrong

  • Troubleshooting
    • Errors and warnings that start with GRANDlib:
    • Nothing raised, but the answer is nan
    • The numbers are wrong but nothing failed
    • Error and warning messages
      • Files and folders
      • Writing files
      • Reading events
      • Values
      • Installation
    • Messages that look like errors and are not
    • Reading files
    • Environment and build
    • Still stuck
  • Known issues
    • Physics and simulation
      • The VGA gain setting has no effect
      • The offline T1 trigger passes few units on clean simulations
      • Smaller physics defects
      • Voltages simulated before 7 September 2026
      • The geomagnetic model ends in 2025
    • Data and file format
      • The sample simulations are dated May 1976
      • magnetic_field is not a vector and its unit is not recorded
      • The file readers depend on file names
      • Fourteen fields change type when a file is read back
      • Antenna positions from GPS use a fixed origin by default
    • Installation and environment
      • Topography, the data layer and the simulation need ROOT
    • Not supported yet
    • Documentation
      • The Handbook has the X and Y antenna arms swapped
    • Where next
  • Logging
    • From the command line
    • From Python
    • In your own script
    • Warnings are separate
    • Where next
  • Getting help
    • Before you ask
    • Opening an issue
    • Contributing a fix

Reference

  • API reference
    • Geometry and frames
      • grand.geo.coordinates
      • grand.geo.topography
      • grand.geo.geomagnet
    • Data model
      • grand.dataio.run_trees
      • grand.dataio.event_trees
      • grand.dataio.data_tree
      • grand.dataio.descriptors
      • grand.dataio.root_files
      • grand.dataio.data_handling
      • grand.dataio.protocol
      • grand.dataio.xmax_frame
    • Simulation
      • grand.sim.efield2voltage
      • grand.sim.detector.antenna_model
      • grand.sim.detector.process_ant
      • grand.sim.detector.rf_chain
      • grand.sim.noise.galaxy
      • grand.sim.detector.adc
      • grand.sim.detector.trigger
      • grand.sim.shower.gen_shower
      • grand.sim.shower.pdg
    • Analysis-oriented interface
      • grand.aoi.event
      • grand.aoi.event_list
      • grand.aoi.antenna
      • grand.aoi.shower
      • grand.aoi.timetrace
    • Reconstruction
      • grand.analysis.fitting.plane_wave
      • grand.analysis.fitting.spherical
      • grand.analysis.fitting.adf
      • grand.analysis.energy_reco.voltage
      • grand.analysis.signals.extraction
      • grand.analysis.cramer_rao_bounds.cramer_rao
      • grand.analysis.physics.cherenkov_angle
      • grand.analysis.physics.atmosphere
      • grand.analysis.coords.array_shower
      • grand.analysis.geom.angles
      • grand.analysis.geom.footprint
      • grand.analysis.constants
    • Signals and traces
      • grand.basis.traces_event
      • grand.basis.signal
      • grand.basis.type_trace
      • grand.basis.du_network
      • grand.basis.pipeline
    • Input checks
      • grand.basis.validate
    • Logging, provenance and C libraries
      • grand.manage_log
      • grand.provenance
      • grand.geo.gull
      • grand.geo.turtle
  • Data format reference
    • Run-level trees
      • TRun
      • TRunVoltage
      • TRunRawVoltage
      • TRunEfieldSim
      • TRunShowerSim
      • TRunNoise
    • Event-level trees
      • TADC
      • TRawVoltage
      • TVoltage
      • TEfield
      • TShower
      • TShowerSim
      • TRecons
  • Data files
    • What is in version control
    • Checking the installation
    • Where they come from
    • Antenna effective length
    • RF-chain S-parameters
    • Galactic noise
    • Topography
    • Geomagnetic field
    • Where next
  • Glossary
  • GRANDlib Handbook
    • Introduction
    • Installation
    • Installation via Docker
      • Installation via Conda
    • Directory Structure
    • Data
      • download_data_grand.py
      • Docs
      • Env
      • Examples
      • Grand
      • Granddb
      • Quality
      • Scripts
      • Sim2Root
      • Src
      • Src_outlib
      • Tests
      • Wheel/
    • Grandlib Classes
    • ROOT Files
    • Errata
  • Platforms, versions and stability
    • Supported platforms
    • Tested versions
    • Version numbers
    • What may change
    • Reproducing a result
    • Where next
  • What’s new
    • dev-next, not yet released
      • Changes that alter results
      • New
      • Other changes
      • Removed
  • Changelog
  • How to cite
    • Citing a specific version
    • Citing the components
  • References

For developers

  • Contributing
    • Setting up
    • The checks and how to run them
    • The lint ratchet
    • Checking input
    • Docstrings
    • Tests
    • Notebooks
    • Documentation
    • Writing style
    • Editing source with scripts
    • The sim2root converters
    • Branches and merging
    • Commits
  • Code architecture
    • What GRANDlib is
    • Forward and back
    • Layering
    • Lazy imports
  • Test suite
    • Running it
    • What a run reports
    • Layout
    • What the tests check
    • Coverage
    • Writing a test
  • Continuous integration
    • The workflows
    • Running the checks locally
    • Testing the Docker route
    • Publishing the documentation
    • Coverage reports
  • Recovery plan
    • What it means for you
    • The phases
    • What remains
    • The full plan
GRANDlib
  • Search
  • Report a problem with this page  

© Copyright 2019-2026, The GRAND Collaboration.

Built with Sphinx using a theme provided by Read the Docs.