SAMPIClyser 0.0.1__tar.gz

sampiclyser-0.0.1/.bumpversion.cfg

@@ -0,0 +1,28 @@
+[bumpversion]
+current_version = 0.0.1
+commit = True
+tag = True
+
+[bumpversion:file:src/sampiclyser/__init__.py]
+search = __version__ = '{current_version}'
+replace = __version__ = '{new_version}'
+
+[bumpversion:file:pyproject.toml]
+search = version = "{current_version}"
+replace = version = "{new_version}"
+
+[bumpversion:file:docs/conf.py]
+search = version = release = '{current_version}'
+replace = version = release = '{new_version}'
+
+[bumpversion:file:tests/test_global.py]
+search = version = '{current_version}'
+replace = version = '{new_version}'
+
+[bumpversion:file (badge):README.rst]
+search = /v{current_version}.svg
+replace = /v{new_version}.svg
+
+[bumpversion:file (link):README.rst]
+search = /v{current_version}...main
+replace = /v{new_version}...main

sampiclyser-0.0.1/.github/workflows/publish-to-test-pypi.yml

@@ -0,0 +1,96 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/<package-name>  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+    - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+    - name: Create GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      run: >-
+        gh release create
+        '${{ github.ref_name }}'
+        --repo '${{ github.repository }}'
+        --notes ""
+    - name: Upload artifact signatures to GitHub Release
+      env:
+        GITHUB_TOKEN: ${{ github.token }}
+      # Upload to GitHub Release using the `gh` CLI.
+      # `dist/` contains the built packages, and the
+      # sigstore-produced signatures and certificates.
+      run: >-
+        gh release upload
+        '${{ github.ref_name }}' dist/**
+        --repo '${{ github.repository }}'

sampiclyser-0.0.1/.gitignore

@@ -0,0 +1,27 @@
+venv/*
+
+*.py[cod]
+__pycache__
+*.feather
+*.parquet
+*.root
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+.eggs
+parts
+bin
+var
+sdist
+wheelhouse
+develop-eggs
+.installed.cfg
+lib
+lib64
+venv*/
+pyvenv*/
+pip-wheel-metadata/

sampiclyser-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,40 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# To install the git pre-commit hook run:
+#   pre-commit install
+# To update the pre-commit hooks run:
+#   pre-commit install-hooks
+exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg)(/|$)'
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.5.0
+  hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: debug-statements
+    - id: check-yaml
+    - id: check-added-large-files
+
+- repo: https://github.com/pycqa/isort
+  rev: 5.13.2
+  hooks:
+    - id: isort
+      name: isort (python)
+
+  # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+  # Alternative: https://github.com/psf/black
+- repo: https://github.com/psf/black-pre-commit-mirror
+  rev: 24.1.1
+  hooks:
+    - id: black
+      # It is recommended to specify the latest version of Python
+      # supported by your project here, or alternatively use
+      # pre-commit's default_language_version, see
+      # https://pre-commit.com/#top_level-default_language_version
+      language_version: python3.11
+
+- repo: https://github.com/pycqa/flake8
+  rev: 7.0.0
+  hooks:
+    - id: flake8
+      additional_dependencies: [Flake8-pyproject]

sampiclyser-0.0.1/.readthedocs.yml

@@ -0,0 +1,35 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+formats: all
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

sampiclyser-0.0.1/AUTHORS.rst

@@ -0,0 +1,4 @@
+Authors
+=======
+
+* Cristóvão Beirão da Cruz e Silva

sampiclyser-0.0.1/CHANGELOG.rst

@@ -0,0 +1,11 @@
+Changelog
+=========
+
+Current (2025-06-19)
+--------------------
+
+
+0.0.1 (2024-06-19)
+------------------
+
+* Test empty release

sampiclyser-0.0.1/CONTRIBUTING.rst

@@ -0,0 +1,83 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Bug reports
+===========
+
+When `reporting a bug <https://github.com/cbeiraod/SAMPIClyser/issues>`_ please include:
+
+    * Your operating system name and version.
+    * Any details about your local setup that might be helpful in troubleshooting.
+    * Detailed steps to reproduce the bug.
+
+Documentation improvements
+==========================
+
+SAMPIClyser could always use more documentation, whether as part of the
+official SAMPIClyser docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at https://github.com/cbeiraod/SAMPIClyser/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
+
+Development
+===========
+
+To set up `SAMPIClyser` for local development:
+
+1. Fork `SAMPIClyser" <https://github.com/cbeiraod/SAMPIClyser>`_
+   (look for the "Fork" button).
+2. Clone your fork locally::
+
+    git clone git@github.com:YOURGITHUBNAME/SAMPIClyser.git
+
+3. Create a branch for local development::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+4. When you're done making changes run all the checks
+
+5. Commit your changes and push your branch to GitHub::
+
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code just make the pull request.
+
+For merging, you should:
+
+1. Include passing tests [1]_.
+2. Update documentation when there's new API, functionality etc.
+3. Add a note to ``CHANGELOG.rst`` about the changes.
+4. Add yourself to ``AUTHORS.rst``.
+
+.. [1] If you don't have all the necessary python versions available locally you can rely on Travis (WIP) - it will
+       `run the tests <https://travis-ci.com/github/cbeiraod/SAMPIClyser/pull_requests>`_
+       for each change you add in the pull request.
+
+       It will be slower though ... and has not yet been set up
+
+Tips
+----
+
+None at the moment

sampiclyser-0.0.1/LICENSE

@@ -0,0 +1,19 @@
+zlib License
+
+(C) 2025 Cristóvão Beirão da Cruz e Silva <cbeiraod@cern.ch>
+
+This software is provided 'as-is', without any express or implied
+warranty.  In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+3. This notice may not be removed or altered from any source distribution.

sampiclyser-0.0.1/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: SAMPIClyser
+Version: 0.0.1
+Summary: Python library to help decoding and analysing data from a SAMPIC system
+Project-URL: Homepage, https://github.com/cbeiraod/SAMPIClyser
+Project-URL: Documentation, https://sampiclyser.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/cbeiraod/SAMPIClyser/issues
+Author-email: Cristóvão Beirão da Cruz e Silva <cbeiraod@cern.ch>
+License-File: AUTHORS.rst
+License-File: LICENSE
+Keywords: Awesome,ROOT,SAMPIC
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: zlib/libpng License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: matplotlib
+Requires-Dist: mplhep
+Requires-Dist: natsort
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: termcolor
+Requires-Dist: uproot
+Description-Content-Type: text/markdown
+
+# SAMPIClyser
+Python library to help decoding and analysing data from a SAMPIC system
+
+You can install the SAMPIClyser libraries with: `python -m pip install SAMPIClyser`
+
+After installation, you can run the individual tools with their dedicated commands:
+ * ``sampiclyser-version`` - To print the version of the SAMPIClyser library in use
+ * ``sampic-convert`` - To read the binary files and save them in a standard format

sampiclyser-0.0.1/PyPIREADME.md

@@ -0,0 +1,8 @@
+# SAMPIClyser
+Python library to help decoding and analysing data from a SAMPIC system
+
+You can install the SAMPIClyser libraries with: `python -m pip install SAMPIClyser`
+
+After installation, you can run the individual tools with their dedicated commands:
+ * ``sampiclyser-version`` - To print the version of the SAMPIClyser library in use
+ * ``sampic-convert`` - To read the binary files and save them in a standard format

sampiclyser-0.0.1/README.rst

@@ -0,0 +1,224 @@
+"""""""""""""
+SAMPIClyser
+"""""""""""""
+
+.. start-badges
+
+|pre-commit|
+
+|black| |flake8| |isort|
+
+|docs|
+
+|version| |wheel| |supported-versions| |supported-implementations|
+
+|commits-since|
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000
+    :target: https://github.com/psf/black
+    :alt: black
+
+.. |flake8| image:: https://img.shields.io/badge/flake8-checked-blueviolet
+    :target: https://github.com/PyCQA/flake8
+    :alt: flake8
+
+.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
+    :target: https://pycqa.github.io/isort/
+    :alt: isort
+
+.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+    :target: https://github.com/pre-commit/pre-commit
+    :alt: pre-commit
+
+.. |docs| image:: https://readthedocs.org/projects/sampiclyser/badge/?version=latest
+    :target: https://sampiclyser.readthedocs.io/
+    :alt: Documentation Status
+
+.. |version| image:: https://img.shields.io/pypi/v/SAMPIClyser.svg
+    :alt: PyPI Package latest release
+    :target: https://pypi.org/project/SAMPIClyser
+
+.. |wheel| image:: https://img.shields.io/pypi/wheel/SAMPIClyser.svg
+    :alt: PyPI Wheel
+    :target: https://pypi.org/project/SAMPIClyser
+
+.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/SAMPIClyser.svg
+    :alt: Supported versions
+    :target: https://pypi.org/project/SAMPIClyser
+
+.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/SAMPIClyser.svg
+    :alt: Supported implementations
+    :target: https://pypi.org/project/SAMPIClyser
+
+.. |commits-since| image:: https://img.shields.io/github/commits-since/cbeiraod/SAMPIClyser/v0.0.1.svg
+    :alt: Commits since latest release
+    :target: https://github.com/cbeiraod/SAMPIClyser/compare/v0.0.1...main
+
+.. end-badges
+
+Python library to help decoding and analysing data from a SAMPIC system
+
+* Free software: Zlib license
+
+
+----------
+
+
+.. contents:: Table of Contents
+   :depth: 3
+
+
+----------
+
+
+====================
+Running the software
+====================
+We will use a venv to isolate the SAMPIClyser python installation and dependencies from that of the system and other venvs.
+Create the venv with: ``python -m venv venv``.
+Venv creation only needs to be done once and occasionally when you upgrade the python version installed on the system.
+
+Before running any commands related to the SAMPIClyser, activate the venv with: ``source venv/bin/activate``
+
+Once you are finished, you may deactivate the venv with: ``deactivate``
+
+---------------------------
+Dependencies & Installation
+---------------------------
+There are two options, you can run the SAMPIClyser from source or from `PyPI <https://pypi.org/>`_ (Recommended).
+
+From PyPI
+---------
+Make sure you activate the venv first, then simply run the command: ``python -m pip install SAMPIClyser``
+
+From Source
+-----------
+Fetch the source from github, you may for instance clone the git repository to a local directory.
+Make sure the venv is activated, then install this application with all its dependencies by running this command from the source directory: ``python -m pip install .``
+
+----------------------
+Developer Dependencies
+----------------------
+If you are working on developing the code for SAMPIClyser you will need to follow the "Running the Software" instructions for setup and then for installing use the "From Source" instructions but instead of the install command in the "Dependencies" instructions, use the following command: ``python -m pip install -e .``.
+Then install a few other dependencies which are only used in development:
+
+.. code:: bash
+
+  python -m pip install --upgrade pytest
+  python -m pip install --upgrade pytest-cov
+  python -m pip install --upgrade pytest-mock
+  python -m pip install --upgrade pre-commit
+  python -m pip install --upgrade bump2version
+  python -m pip install --upgrade black
+  python -m pip install --upgrade flake8-pyproject
+  python -m pip install --upgrade isort
+  python -m pip install --upgrade build
+  python -m pip install --upgrade twine
+
+
+Then install the pre-commit hooks so that things are ran automatically before any commit is done: ``pre-commit install``.
+
+
+------------
+
+
+==============
+Developer Info
+==============
+
+-----
+Tools
+-----
+
+pytest
+------
+We are using pytest to run unit tests on the software.
+See `here <https://docs.pytest.org/en/7.4.x/getting-started.html>`_ for ideas on how to get started.
+Use the command ``pytest`` to run all the tests.
+
+We use the pytest-cov plugin to get coverage reports from pytest.
+Use the command ``pytest --cov --cov-report term-missing`` to run all the tests and get a coverage report.
+Use the command ``pytest --cov --cov-report term-missing --cov-report html`` to get an html report with detailed information.
+
+We use the pytest-mock plugin in order to use the mock class in our tests.
+
+pre-commit
+----------
+**pre-commit may need to be installed in the global python environment for things to work correctly.**
+This tool allows to setup hooks into the git workflow, in particular for the Pre-Commit Hook, allowing to run automated tests before committing code.
+This functionality is used to automatically run black, flake8 and isort before any commit is made, thus guaranteeing a consistent style and formatting for all committed code (according to these tools).
+If you want to run all the checks individually as if a commit were about to be made, you can use ``pre-commit run --all-files``.
+You can find more information on pre-commit `here <https://pre-commit.com/>`_.
+
+bump2version
+------------
+We are using bump2version to manage the version string of the software.
+bump2version will automatically create a commit and a tag with the version when you use it:
+
+- To increase the major version, use: ``bump2version major``; for example 0.1.3 to 1.0.0
+- To increase the minor version, use: ``bump2version minor``; for example 0.1.3 to 0.2.0
+- To increase the patch version, use: ``bump2version patch``; for example 0.1.3 to 0.1.4
+
+black
+-----
+We are using black to automatically format the python code.
+To run black standalone use: ``black .`` in the root directory.
+You may also use ``black --check -v .`` to get a list of which changes would be made, without actually making them.
+More information on black can be found `here <https://pypi.org/project/black/>`_.
+
+flake8
+------
+We are using flake8 to check the code for style and syntax errors (i.e. a linter tool).
+The flake8-pyproject enables flake8 to read configuration from the pyproject.toml file, and pulls flake8 as a dependency.
+This is why flake8 is not explicitly installed.
+To run flake8 standalone, use: ``flake8`` in the root directory.
+More information on flake8 can be found `here <https://flake8.pycqa.org/en/latest/index.html#quickstart>`_.
+A list of all options and configuration for the toml file can be found `here <https://flake8.pycqa.org/en/latest/user/options.html>`_.
+
+isort
+-----
+We are using isort to automatically sort the include statements at the top of the python files.
+To run isort standalone use: ``isort .`` in the root directory.
+More information on isort can be found `here <https://pycqa.github.io/isort/>`_.
+
+build
+-----
+The build tool is used to package the code for publishing on PyPI.
+Build the release with: ``python -m build``
+
+twine
+-----
+The twine tool is used to upload the package to PyPI.
+Once the distribution files are generated with the build tool, then upload them with: ``python -m twine upload --repository testpypi dist/*``
+
+----------------
+Github Workflows
+----------------
+Currently there is a single github workflow which builds and publishes a properly tagged version of the repo onto PyPI.
+We plan to use other github workflows as our CI tools, to be added.
+
+publish-to-test-pypi
+--------------------
+This workflow publishes to PyPI a properly tagged commit of the repository.
+Some initial setup in needed on PyPI so that things run smoothly, but once running it should continue to function without intervention needed.
+
+-----------------
+Restructured Text
+-----------------
+For information on how to use restructured text, see the cheatsheet `here <https://github.com/DevDungeon/reStructuredText-Documentation-Reference>`_ for example.
+But there are other resources on the internet if you prefer.
+
+----------
+Docstrings
+----------
+Please use docstrings in the "NumPy/SciPy docstrings" style: `link <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
+
+--------------
+pyproject.toml
+--------------
+Get classifiers from `here <https://pypi.org/classifiers/>`_.
+
+More information on packaging can be found `here <https://packaging.python.org/en/latest/tutorials/packaging-projects/>`_.
+
+There are entry points as explained in: https://packaging.python.org/en/latest/specifications/declaring-project-metadata/#declaring-project-metadata
+There is an entry point to run the binary conversion tool, for example: ``sampic-convert`` tool, use the help to see the options.

sampiclyser-0.0.1/docs/authors.rst

@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst

sampiclyser-0.0.1/docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

sampiclyser-0.0.1/docs/conf.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import os
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.coverage',
+    'sphinx.ext.doctest',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+]
+source_suffix = '.rst'
+master_doc = 'index'
+project = 'SAMPIClyser'
+year = '2025'
+author = 'Cristóvão B. da Cruz e Silva'
+copyright = '{0}, {1}'.format(year, author)
+version = release = '0.0.1'
+
+pygments_style = 'trac'
+templates_path = ['.']
+extlinks = {
+    'issue': ('https://github.com/cbeiraod/SAMPIClyser/issues/%s', '#'),
+    'pr': ('https://github.com/cbeiraod/SAMPIClyser/pull/%s', 'PR #'),
+}
+# on_rtd is whether we are on readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only set the theme if we're building docs locally
+    html_theme = 'sphinx_rtd_theme'
+
+html_use_smartypants = True
+html_last_updated_fmt = '%b %d, %Y'
+html_split_index = False
+html_sidebars = {
+    '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'],
+}
+html_short_title = '%s-%s' % (project, version)
+
+napoleon_use_ivar = True
+napoleon_use_rtype = False
+napoleon_use_param = False

sampiclyser-0.0.1/docs/contributing.rst

@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst

sampiclyser-0.0.1/docs/index.rst

@@ -0,0 +1,21 @@
+========
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   reference/index
+   contributing
+   authors
+   changelog
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

sampiclyser-0.0.1/docs/installation.rst

@@ -0,0 +1,7 @@
+============
+Installation
+============
+
+At the command line::
+
+    python -m pip install SAMPIClyser

sampiclyser-0.0.1/docs/readme.rst

@@ -0,0 +1 @@
+.. include:: ../README.rst

sampiclyser-0.0.1/docs/reference/index.rst

@@ -0,0 +1,7 @@
+Reference
+=========
+
+.. toctree::
+    :glob:
+
+    sampiclyser*

sampiclyser-0.0.1/docs/reference/sampiclyser.rst

@@ -0,0 +1,15 @@
+SAMPIClyser package
+=================
+
+.. testsetup::
+
+    from sampiclyser import *
+
+
+Module contents
+---------------
+
+.. automodule:: sampiclyser
+   :members:
+   :undoc-members:
+   :show-inheritance:

sampiclyser-0.0.1/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx>=1.3
+sphinx-rtd-theme

sampiclyser-0.0.1/docs/spelling_wordlist.txt

@@ -0,0 +1,11 @@
+builtin
+builtins
+classmethod
+staticmethod
+classmethods
+staticmethods
+args
+kwargs
+callstack
+Changelog
+Indices

sampiclyser-0.0.1/docs/usage.rst

@@ -0,0 +1,7 @@
+=====
+Usage
+=====
+
+To use SAMPIClyser in a project::
+
+	import sampiclyser

sampiclyser-0.0.1/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "SAMPIClyser"
+version = "0.0.1"
+authors = [
+  { name="Cristóvão Beirão da Cruz e Silva", email="cbeiraod@cern.ch" },
+]
+maintainers = [
+]
+description = "Python library to help decoding and analysing data from a SAMPIC system"
+readme = "PyPIREADME.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: zlib/libpng License",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+    "Topic :: Scientific/Engineering",
+]
+keywords = ["SAMPIC", "ROOT", "Awesome"]
+dependencies = [
+    "natsort",
+    "numpy",
+    "pandas",
+    "termcolor",
+    "pyarrow",
+    "uproot",
+    "mplhep",
+    "matplotlib",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/cbeiraod/SAMPIClyser"
+"Documentation" = "https://sampiclyser.readthedocs.io/"
+"Bug Tracker" = "https://github.com/cbeiraod/SAMPIClyser/issues"
+
+[project.scripts]
+sampiclyser-version = "sampiclyser.entry_points:version"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib"
+]
+
+[tool.black]
+line-length = 140
+target-version = ["py310", "py311", "py312"]
+skip-string-normalization = true
+required-version = 24
+extend-exclude = '''
+# A regex preceded with ^/ will apply only to files and directories
+# in the root of the project.
+(
+  venv
+  dist
+  build
+  .pytest_cache
+  .github
+)
+'''
+
+[tool.flake8]
+# Default: E121,E123,E126,E226,E24,E704,W503,W504
+extend-ignore = ['E203','E501','E701']
+extend-select = ['B950']
+exclude = ".git, .github, venv, .mypy_cache, .pytest_cache, build, dist, __pycache__"
+per-file-ignores = [
+    '__init__.py:F401',
+]
+max-line-length = 140
+max-complexity = 18
+count = true
+
+[tool.isort]
+profile = "black"
+force_single_line = true
+line_length = 140
+known_first_party = ['sampiclyser']
+default_section = 'THIRDPARTY'
+forced_separate = 'test_sampiclyser'
+skip = ".pytest_cache,.git,.github,venv,build,dist"

sampiclyser-0.0.1/pytest.ini

@@ -0,0 +1,24 @@
+[pytest]
+# If a pytest section is found in one of the possible config files
+# (pytest.ini, tox.ini or setup.cfg), then pytest will not look for any others,
+# so if you add a pytest config section elsewhere,
+# you will need to delete this section.
+norecursedirs =
+    migrations
+
+python_files =
+    test_*.py
+    *_test.py
+    tests.py
+addopts =
+    -ra
+    --strict-markers
+    --doctest-modules
+    --doctest-glob=\*.rst
+    --tb=short
+testpaths =
+    tests
+
+# Idea from: https://til.simonwillison.net/pytest/treat-warnings-as-errors
+filterwarnings =
+    error

sampiclyser-0.0.1/src/sampiclyser/__init__.py

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+#############################################################################
+# zlib License
+#
+# (C) 2025 Cristóvão Beirão da Cruz e Silva <cbeiraod@cern.ch>
+#
+# This software is provided 'as-is', without any express or implied
+# warranty.  In no event will the authors be held liable for any damages
+# arising from the use of this software.
+#
+# Permission is granted to anyone to use this software for any purpose,
+# including commercial applications, and to alter it and redistribute it
+# freely, subject to the following restrictions:
+#
+# 1. The origin of this software must not be misrepresented; you must not
+#    claim that you wrote the original software. If you use this software
+#    in a product, an acknowledgment in the product documentation would be
+#    appreciated but is not required.
+# 2. Altered source versions must be plainly marked as such, and must not be
+#    misrepresented as being the original software.
+# 3. This notice may not be removed or altered from any source distribution.
+#############################################################################
+
+from __future__ import annotations
+
+__version__ = '0.0.1'
+
+from .sampic_decoder import SAMPIC_Run_Decoder
+
+__all__ = ["SAMPIC_Run_Decoder"]

sampiclyser-0.0.1/src/sampiclyser/entry_points.py

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#############################################################################
+# zlib License
+#
+# (C) 2025 Cristóvão Beirão da Cruz e Silva <cbeiraod@cern.ch>
+#
+# This software is provided 'as-is', without any express or implied
+# warranty.  In no event will the authors be held liable for any damages
+# arising from the use of this software.
+#
+# Permission is granted to anyone to use this software for any purpose,
+# including commercial applications, and to alter it and redistribute it
+# freely, subject to the following restrictions:
+#
+# 1. The origin of this software must not be misrepresented; you must not
+#    claim that you wrote the original software. If you use this software
+#    in a product, an acknowledgment in the product documentation would be
+#    appreciated but is not required.
+# 2. Altered source versions must be plainly marked as such, and must not be
+#    misrepresented as being the original software.
+# 3. This notice may not be removed or altered from any source distribution.
+#############################################################################
+"""The Entry Points module
+
+This is a utility module holds all the CLI entry points
+
+"""
+
+import argparse
+
+from sampiclyser import __version__
+
+
+def version(args=None):
+    """This is the entry function for the command line interface to print out the version"""
+    parser = argparse.ArgumentParser(description='Print the SAMPIClyser version')
+    # parser.add_argument('names', metavar='NAME', nargs=argparse.ZERO_OR_MORE,
+    #                 help="A name of something.")
+    args = parser.parse_args(args=args)
+
+    print(f"The SAMPIClyser version is: {__version__}")

sampiclyser-0.0.1/tests/test_global.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+#############################################################################
+# zlib License
+#
+# (C) 2025 Cristóvão Beirão da Cruz e Silva <cbeiraod@cern.ch>
+#
+# This software is provided 'as-is', without any express or implied
+# warranty.  In no event will the authors be held liable for any damages
+# arising from the use of this software.
+#
+# Permission is granted to anyone to use this software for any purpose,
+# including commercial applications, and to alter it and redistribute it
+# freely, subject to the following restrictions:
+#
+# 1. The origin of this software must not be misrepresented; you must not
+#    claim that you wrote the original software. If you use this software
+#    in a product, an acknowledgment in the product documentation would be
+#    appreciated but is not required.
+# 2. Altered source versions must be plainly marked as such, and must not be
+#    misrepresented as being the original software.
+# 3. This notice may not be removed or altered from any source distribution.
+#############################################################################
+
+import pytest
+
+
+def test_version():
+    import sampiclyser
+
+    version = '0.0.1'
+
+    pytest.param
+
+    assert version == sampiclyser.__version__