Metadata-Version: 2.1
Name: pypixie16
Version: 3.0.0
Author-email: Arun Persaud <apersaud@lbl.gov>, Ariel Amsellem <ajamsellem@lbl.gov>, Andrew Rosenstrom <arosenstrom@lbl.gov>, Brian Mak <brianmak@lbl.gov>, Mauricio Ayllon Unzueta <mayllonu@lbl.gov>, Will Larsen <wlarsen@lbl.gov>, Caroline Egan <cegan@lbl.gov>
License: Pixie16 Python Interface (Pixie 16) v1 Copyright (c) 2019, The Regents
        of the University of California, through Lawrence Berkeley National
        Laboratory (subject to receipt of any required approvals from the
        U.S. Dept. of Energy). All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are
        met:
        
        (1) Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
        
        (2) Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
        
        (3) Neither the name of the University of California, Lawrence
        Berkeley National Laboratory, U.S. Dept. of Energy, nor the names of
        its contributors may be used to endorse or promote products derived
        from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
        A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
        OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
        SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
        LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
        THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
        You are under no obligation whatsoever to provide any bug fixes,
        patches, or upgrades to the features, functionality or performance of
        the source code ("Enhancements") to anyone; however, if you choose to
        make your Enhancements available either publicly, or directly to
        Lawrence Berkeley National Laboratory, without imposing a separate
        written license agreement for such Enhancements, then you hereby grant
        the following license: a non-exclusive, royalty-free perpetual license
        to install, use, modify, prepare derivative works, incorporate into
        other computer software, distribute, and sublicense such enhancements
        or derivative works thereof, in binary and source code form.
        
        
Project-URL: documentation, https://pypixie16.readthedocs.io/en/latest/
Project-URL: homepage, https://bitbucket.org/berkeleylab/pypixie16
Project-URL: issues, https://bitbucket.org/berkeleylab/pypixie16/issues
Project-URL: changelog, https://bitbucket.org/berkeleylab/pypixie16/src/main/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: appdirs
Requires-Dist: bitstruct
Requires-Dist: docopt
Requires-Dist: fast-histogram
Requires-Dist: matplotlib
Requires-Dist: msgspec
Requires-Dist: more_itertools
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pint
Requires-Dist: platformdirs
Requires-Dist: PyQt6
Requires-Dist: rich
Requires-Dist: setuptools
Requires-Dist: setuptools_scm
Requires-Dist: tables
Provides-Extra: fast
Requires-Dist: cbitstruct; extra == "fast"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: docs
Requires-Dist: alabaster; extra == "docs"
Requires-Dist: markupsafe; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
Requires-Dist: recommonmark; extra == "docs"

# PyPixie16

[![Docs](https://readthedocs.org/projects/pypixie16/badge/?version=latest&style=plastic)](https://readthedocs.org/projects/pypixie16)
[![PyPI version](https://badge.fury.io/py/pypixie16.svg)](https://badge.fury.io/py/pypixie16)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)


This module can be used to control, read, and analyze data from
Pixie16 modules from XIA [https://www.xia.com/DGF_Pixie-16.html] using python. To achieve this we provide
cytpes interface to the C-libraries provided by XIA. These libraries
need to be downloaded and installed from XIA-website for these python
modules to run.

We use a config.ini file to let the python file know where those
libraries can be found. If this file doesn't exist, the program will
prompt you with instructions on how to create one.

# Licence and Copyright

See Licence.txt and Copyright.txt for more information.

# Installation

You can install the package using

   pip install pypixie16

or after you cloned the repository and are inside the repo,

   pip install .

or

   pip install -e .

If you want to run tests, you should specify

   pip install .[test]

If you want to build the documentation

   pip install .[docs]

If you want to speed up binary parsing, you should install the `cbitstruct` library or use

   pip install .[fast]

# Documentation

Documentation is hosted on Read The Docs: https://readthedocs.org/projects/pypixie16/

# Known issues

We use revision F of the 500 MHz Pixie16 and the code has only been
tested for this module. It probably can be easily adapted for other
modules or even might work, but there is no garantee.

We also always use certain settings for some parameters and these
might also influence some of the analysis code (e.g. FastFilterRange).

# Tests

We should have a lot more of them ;)

Use

   python -m pytest

to run tests.

# Contribution

Pull requests are welcome.

We use black to format the code. Once you cloned the repo, please run

   pip install pre-commit

and

   pre-commit install

# Other libraries to control the pixie16 (non-python)

## Experimental Low Energy Nuclear Science Group at University of Tennessee

https://github.com/pixie16

## Fork of pixie16

https://github.com/spaulaus/paass-lc

## Peking University

https://github.com/pkuNucExp/PKUXIADAQ



