Welcome to Hipopy’s documentation!

Hipopy is a Python library for reading CLAS12 HIPO files directly into Awkward or Numpy arrays. It uses hipopybind and PyBind11 to import classes from C++ HIPO libraries into python and offers a simple and intuitive API similar to UpROOT.

Note

This project is under active development.

Contents

• HIPOPy: UpROOT-like I/O Interface for CLAS12 HIPO Files
  • Prerequisites
  • Installation
  • Getting Started
  • Documentation
• Examples
  • Opening a HIPO File
  • Reading a Single File
  • Iterating Many Files
  • Writing Files
  • Modifying Files
• API
  • create()
  • hipochain
  • hipochainIterator
    • hipochainIterator.switchFile()
  • hipochainIteratorExperimental
    • hipochainIteratorExperimental.getAllBankNames()
  • hipofile
    • hipofile.addEvent()
    • hipofile.addSchema()
    • hipofile.close()
    • hipofile.extend()
    • hipofile.flush()
    • hipofile.getBanks()
    • hipofile.getBytes()
    • hipofile.getDoubles()
    • hipofile.getEntries()
    • hipofile.getFloats()
    • hipofile.getInts()
    • hipofile.getItem()
    • hipofile.getLongs()
    • hipofile.getNames()
    • hipofile.getNamesAndTypes()
    • hipofile.getRows()
    • hipofile.getShorts()
    • hipofile.getTypes()
    • hipofile.goToEvent()
    • hipofile.hasBank()
    • hipofile.newTree()
    • hipofile.nextEvent()
    • hipofile.open()
    • hipofile.readAllBanks()
    • hipofile.readBank()
    • hipofile.show()
    • hipofile.showBank()
    • hipofile.update()
    • hipofile.write()
    • hipofile.writeAllBanks()
    • hipofile.writeBank()
    • hipofile.writeEvent()
  • hipofileIterator
  • iterate()
  • open()
  • recreate()