Getting Started

Installation

From PyPI:

pip install epics

With optional extras:

# Plotting and pandas support
pip install "epics[plot,pandas]"

# All optional dependencies
pip install "epics[all]"

From source (development):

git clone https://github.com/melekderman/PyEPICS.git
cd PyEPICS
pip install -e ".[dev]"

See INSTALL.md for full details.

Quick Start

High-level client API:

from pyepics import EPICSClient

client = EPICSClient("data/endf")

# Query an element by symbol, name, or atomic number
fe = client.get_element("Fe")
print(fe.Z, fe.symbol)            # 26, "Fe"
print(fe.binding_energies)         # {'K': 7112.0, 'L1': 844.6, ...}
print(fe.electron_cross_section_labels)

# Compare multiple elements
df = client.compare_df(["Fe", "Cu", "Au"])

Low-level reader API:

from pyepics import EEDLReader

reader = EEDLReader()
dataset = reader.read("data/endf/eedl/EEDL.ZA026000.endf")
print(dataset.Z, dataset.symbol)  # 26, "Fe"

See User Guide for more examples including plotting and reading HDF5 output files.