Metadata-Version: 2.4
Name: ucndata
Version: 4.0.2
Summary: Python class for reading UCN runs converted to ROOT with midas2root
Project-URL: Homepage, https://github.com/ucn-triumf/UCNanalysis/tree/2024
Project-URL: Bug Tracker, https://github.com/ucn-triumf/UCNanalysis/issues
Author-email: Derek Fujimoto <dfujimoto@triumf.ca>
License-File: LICENSE
Keywords: Analysis,PyRoot,TRIUMF,TUCAN,UCN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5
Requires-Dist: datetime
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: rootloader
Requires-Dist: tqdm
Description-Content-Type: text/markdown

# ucndata

This repository defines the `ucndata` package and a few scripts which utilize this package to analyze UCN ROOT files.

The `ucndata` package contained within has been installed system-wide on `daq04`. You will therefore be able to import it from any directory.

## ucndata quick links

* [Installation](tutorials/installation.md)
* [Getting Started](tutorials/gettingstarted.md)
* [Tutorial](tutorials/index.md)
* [Full API reference](docs/README.md)

## Quick API Reference

These are the main workhorses of the ucndata project:

* [ucnbase](docs/ucnbase.md) - base class for the following:
* [ucnrun](docs/ucnrun.md) - workhorse object representing a single run
* [ucncycle](docs/ucncycle.md) - workhorse object representing a single cycle within a run
* [ucnperiod](docs/ucnperiod.md) - workhorse object representing a single period within a cycle

But these can also be useful:

* [applylist](docs/applylist.md) - for working with sets of runs or cycles or periods. Does element-wise attribute access and operators
* [datetime](docs/datetime.md) - convert timestamps to datetime objects and back

