Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 810 Bytes

readme.md

File metadata and controls

29 lines (23 loc) · 810 Bytes
Raw

emcfile

This package provides useful utilities for the emc photon format and its corresponding detector files.

Installation

Dependencies:

  • python >= 3.9
  • numpy >= 1.22
  • h5py
  • scipy

Documentation

This package can be divided into three parts roughly:

  • handle classes and functions for HDF5 file
  • detector file related classes and functions
  • pattern file related classes and functions

The tutorial, tutorial/tutorial_00.py, is recommended as the starting point of this package. You could use jupytext to generate a jupyter notebook file for a more interactive experience with the following command

jupytext tutorial_00.py -o tutorial_00.ipynb

Conventions

Patterns

For a pattern object, its first index is always the pattern index.