Logo

Contents:

  • Introduction
  • Installation
    • Recommended: Container Workflow
    • Local pip Installation
      • Core Package
      • Optional Python Extras
        • Machine Learning Models
        • Visualization Tools
        • Development Tools
        • All Dependencies
      • Python And Dependency Requirements
      • Development From Source
  • Quick Start
    • Run SPINE In The Container
    • Run SPINE From Python
    • Run JupyterLab Or Classic Notebook
    • When To Use Local Python Installs
    • Next Steps
  • Advanced YAML Config Loader
    • Features
      • 1. Top-Level File Includes
      • 2. Inline File Includes
      • 3. Dot-Notation Override
      • 4. Removing Keys
    • Complete Example
    • Usage in Python
    • Command-Line Overrides
    • Benefits
    • Notes
  • API Reference
    • SPINE Core
      • Core Entry Points
        • spine.driver
        • spine.main
    • Configuration Module
      • Main Entry Point
      • Core Interfaces
        • spine.config.load.load_config
        • spine.config.load.load_config_file
        • spine.config.download.download_from_url
        • spine.config.download.get_cache_dir
        • spine.config.errors.ConfigError
        • spine.config.errors.ConfigIncludeError
        • spine.config.errors.ConfigCycleError
        • spine.config.errors.ConfigPathError
        • spine.config.errors.ConfigTypeError
        • spine.config.errors.ConfigOperationError
        • spine.config.errors.ConfigValidationError
    • Constants Module
      • Guiding principle
      • Submodules
        • spine.constants.columns
        • spine.constants.enums
        • spine.constants.factory
        • spine.constants.labels
        • spine.constants.physics
        • spine.constants.sentinels
    • Data Module
      • Overview
      • LArCV Data Structures
        • spine.data.larcv.Particle
        • spine.data.larcv.Neutrino
        • spine.data.larcv.CRTHit
        • spine.data.larcv.Flash
        • spine.data.larcv.Trigger
        • spine.data.larcv.Meta
        • spine.data.larcv.RunInfo
      • Output Data Structures
        • Fragment Objects
        • Particle Objects
        • Interaction Objects
      • Batch Data Structures
        • spine.data.batch.TensorBatch
        • spine.data.batch.EdgeIndexBatch
        • spine.data.batch.IndexBatch
      • Other Data Structures
        • spine.data.ObjectList
    • Construct Module
      • Overview
      • Reference
        • spine.construct.BuildManager
        • spine.construct.fragment.FragmentBuilder
        • spine.construct.particle.ParticleBuilder
        • spine.construct.interaction.InteractionBuilder
    • Geometry Module
      • Core Interfaces
        • spine.geo.base.Geometry
        • spine.geo.manager.GeoManager
    • Input/Output Module
      • Overview
      • File Readers
        • spine.io.read.HDF5Reader
        • spine.io.read.LArCVReader
        • spine.io.read.StageHDF5Reader
      • File Writers
        • spine.io.write.HDF5Writer
        • spine.io.write.CSVWriter
        • spine.io.write.StageHDF5Writer
      • Datasets
        • spine.io.dataset.LArCVDataset
        • spine.io.dataset.HDF5Dataset
        • spine.io.dataset.MixedDataset
      • Parsers
        • spine.io.parse.base
        • spine.io.parse.data
        • spine.io.parse.clean_data
        • spine.io.parse.hdf5.tensor
        • spine.io.parse.hdf5.index
        • spine.io.parse.hdf5.object
        • spine.io.parse.larcv.misc
        • spine.io.parse.larcv.sparse
        • spine.io.parse.larcv.cluster
        • spine.io.parse.larcv.particle
      • Data Pipeline Utilities
        • spine.io.collate
        • spine.io.sample
        • spine.io.augment
        • spine.io.overlay
        • spine.io.factories
    • Analysis Module
      • Module Index
        • spine.ana.base
        • spine.ana.manager
        • spine.ana.template
        • spine.ana.factories
        • spine.ana.calib
        • spine.ana.diag
        • spine.ana.metric
    • Math Module
      • Core Modules
        • spine.math.base
        • spine.math.cluster
        • spine.math.decomposition
        • spine.math.distance
        • spine.math.graph
        • spine.math.linalg
        • spine.math.metrics
        • spine.math.neighbors
    • Model Module
      • Module Index
        • spine.model.manager
        • spine.model.factories
        • spine.model.uresnet
        • spine.model.uresnet_ppn
        • spine.model.spice
        • spine.model.full_chain
        • spine.model.image
        • spine.model.singlep
        • spine.model.vertex
        • spine.model.grappa
        • spine.model.graph_spice
        • spine.model.bayes_uresnet
        • spine.model.layer
    • Post-processing Module
      • Example configuration
      • Module Index
        • spine.post.base
        • spine.post.manager
        • spine.post.factories
        • spine.post.template
        • spine.post.crt
        • spine.post.optical
        • spine.post.reco
        • spine.post.trigger
        • spine.post.truth
    • Utilities
      • Core Utilities
        • spine.utils.conditional
        • spine.utils.docstring
        • spine.utils.factory
        • spine.utils.globals
        • spine.utils.logger
        • spine.utils.stopwatch
      • Physics And Reconstruction Utilities
        • spine.utils.energy_loss
        • spine.utils.match
        • spine.utils.metrics
        • spine.utils.optical
        • spine.utils.particles
        • spine.utils.pid
        • spine.utils.ppn
        • spine.utils.tracking
        • spine.utils.vertex
        • spine.utils.weighting
      • Numerical And Graph Utilities
        • spine.utils.cluster
        • spine.utils.gnn
        • spine.utils.inference
        • spine.utils.jit
        • spine.utils.torch
    • Visualization Module
      • Module Index
        • spine.vis.layout
        • spine.vis.out
        • spine.vis.point
        • spine.vis.arrow
        • spine.vis.box
        • spine.vis.cone
        • spine.vis.cylinder
        • spine.vis.ellipsoid
        • spine.vis.hull
        • spine.vis.cluster
        • spine.vis.particle
        • spine.vis.network
        • spine.vis.lite
        • spine.vis.train
        • spine.vis.geo
        • spine.vis.metric
SPINE
  • Search

© Copyright 2024, DeepLearningPhysics Collaboration.

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