daplis 1.1.1__tar.gz

daplis-1.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Sergei Kulkov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

daplis-1.1.1/MANIFEST.in

@@ -0,0 +1,2 @@
+include src/daplis/params/masks/*.txt
+include src/daplis/params/calibration_data/*.csv

daplis-1.1.1/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.2
+Name: daplis
+Version: 1.1.1
+Summary: Data Analysis Package for LInoSpad
+Author-email: Sergei Kulkov <sergei.kulkov23@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/rngKomorebi/daplis
+Keywords: timestamp,analysis,LinoSPAD2
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lmfit>=0.9.1
+Requires-Dist: matplotlib>=3.5.0
+Requires-Dist: numpy>=1.22.4
+Requires-Dist: pandas>=1.4.0
+Requires-Dist: pyarrow>=17.0.0
+Requires-Dist: scipy>=1.7.0
+Requires-Dist: seaborn>=0.9.0
+Requires-Dist: tqdm>=4.67.0
+
+## Data Analysis Package for LInoSpad (DAPLIS)
+
+Package for unpacking and analyzing the binary data from the timestamping mode of the LinoSPAD2 detector.
+
+![Tests](https://github.com/rngKomorebi/LinoSPAD2/actions/workflows/tests.yml/badge.svg)
+![Documentation](https://github.com/rngKomorebi/LinoSPAD2/actions/workflows/documentation.yml/badge.svg)
+![PyPI - Version](https://img.shields.io/pypi/v/daplis)
+![PyPI - License](https://img.shields.io/pypi/l/daplis)
+
+## Introduction
+
+This package was written for data analysis for LinoSPAD2, mainly for
+analysis of the timestamp output. The key functions are ones for
+unpacking the binary output of the detector that utilizes the numpy
+Python library for quick unpacking of .dat files to matrices,
+dictionaries, or data frames.
+
+This library greatly streamlines working with raw timestamps from 
+the LinoSPAD2 camera. With this package, one can analyze dark current 
+rate, cross-talk probability, plot sensor population, and analyze the
+raw data to look for photon coincidences.
+
+## Structure of the package
+
+The "functions" folder holds all functions from unpacking to plotting
+numerous types of graphs (pixel population, histograms of timestamp
+differences, etc.)
+
+The "params" folder holds masks (used to mask some of the noisiest
+pixels) and calibration data (compensating for TDC nonlinearities and
+offset) for LinoSPAD2 daughterboards.
+
+The "archive" folder is a collection of scripts for debugging, tests,
+older versions of functions, etc.
+
+The "examples" folder contains a few jupyter notebooks with examples
+on how to use the main functions, showcasing how to work with the
+most important function parameters.
+
+Full documentation, including examples and full documentation of
+modules and functions, can be found [here](https://rngkomorebi.github.io/daplis/).
+
+Some functions (mainly the plotting ones) save plots as pictures in the
+.png format, creating a folder for the output in the same folder that
+holds the data. Others (such as delta_t.py for collecting timestamp differences
+in the given time window) save .csv or .feather files with the processed data for
+easier and faster plotting.
+
+Additionally, a standalone repo with an application for online plotting
+of the sensor population can be found [here](https://github.com/rngKomorebi/LinoSPAD2-app).
+
+## Installation and usage
+
+A fresh, separate virtual environment is highly recommended before installing the package.
+This can be done using pip, see, e.g., [this](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/).
+This can help to avoid any dependency conflicts and ensure smooth operation of the
+package.
+
+First, check if the virtualenv package is installed. To do this, one can run:
+```
+pip show virtualenv
+```
+If the package was not found, it can be installed using:
+```
+pip install virtualenv
+```
+To create a new environment, run the following:
+```
+virtualenv PATH/TO/NEW/ENVIRONMENT
+```
+To activate the environment (on Windows):
+```
+PATH/TO/NEW/ENVIRONMENTScripts/activate
+```
+and on Linux:
+```
+source PATH/TO/NEW/ENVIRONMENTbin/activate
+```
+
+Then, package itself can be installed using pip inside the environment:
+```
+pip install daplis
+```
+
+Alternatively, to start using the package, one can download the whole repo. "requirements.txt" 
+lists all packages required for this project to run. One can create 
+an environment for this project either using conda or pip following the instruction 
+above. Once the new environmnt is activated, run the following to install 
+the required packages:
+```
+cd PATH/TO/GITHUB/CODES/daplis
+pip install -r requirements.txt
+```
+Now, the package can be installed via
+```
+pip install -e .
+```
+where '-e' stands for editable: any changes introduced to the package will
+instantly become a part of the package and can be used without the need
+of reinstalling the whole thing. After that, one can import any function 
+from the daplis package:
+```
+from daplis.functions import sensor_plot, delta_t, fits
+```
+
+For conda users, the new environment can be installed using the 'requirements' 
+text file directly:
+```
+conda create --name NEW_ENVIRONMENT_NAME --file /PATH/TO/requirements.txt -c conda-forge
+```
+To install the package, first, switch to the created environment:
+```
+conda activate NEW_ENVIRONMENT_NAME
+```
+and run
+```
+pip install -e .
+```
+
+For a fast introduction on how to use the package, please see the
+jupyter notebooks with examples on the main functions at "daplis/examples/".
+
+## How to contribute
+
+This repo consists of two branches: 'main' serves as the release version
+of the package, tested, proven to be functional, and ready to use, while
+the 'develop' branch serves as the main hub for testing new stuff. To
+contribute, the best way would be to fork the repository and use the 'develop'
+branch for new introductions, submitting the results via pull requests. 
+Everyone willing to contribute is kindly asked to follow the 
+[PEP 8](https://peps.python.org/pep-0008/) and 
+[PEP 257](https://peps.python.org/pep-0257/) conventions.
+
+## License and contact info
+
+This package is available under the MIT license. See LICENSE for more
+information. If you'd like to contact me, the author, feel free to
+write at sergei.kulkov23@gmail.com.

daplis-1.1.1/README.md

@@ -0,0 +1,138 @@
+## Data Analysis Package for LInoSpad (DAPLIS)
+
+Package for unpacking and analyzing the binary data from the timestamping mode of the LinoSPAD2 detector.
+
+![Tests](https://github.com/rngKomorebi/LinoSPAD2/actions/workflows/tests.yml/badge.svg)
+![Documentation](https://github.com/rngKomorebi/LinoSPAD2/actions/workflows/documentation.yml/badge.svg)
+![PyPI - Version](https://img.shields.io/pypi/v/daplis)
+![PyPI - License](https://img.shields.io/pypi/l/daplis)
+
+## Introduction
+
+This package was written for data analysis for LinoSPAD2, mainly for
+analysis of the timestamp output. The key functions are ones for
+unpacking the binary output of the detector that utilizes the numpy
+Python library for quick unpacking of .dat files to matrices,
+dictionaries, or data frames.
+
+This library greatly streamlines working with raw timestamps from 
+the LinoSPAD2 camera. With this package, one can analyze dark current 
+rate, cross-talk probability, plot sensor population, and analyze the
+raw data to look for photon coincidences.
+
+## Structure of the package
+
+The "functions" folder holds all functions from unpacking to plotting
+numerous types of graphs (pixel population, histograms of timestamp
+differences, etc.)
+
+The "params" folder holds masks (used to mask some of the noisiest
+pixels) and calibration data (compensating for TDC nonlinearities and
+offset) for LinoSPAD2 daughterboards.
+
+The "archive" folder is a collection of scripts for debugging, tests,
+older versions of functions, etc.
+
+The "examples" folder contains a few jupyter notebooks with examples
+on how to use the main functions, showcasing how to work with the
+most important function parameters.
+
+Full documentation, including examples and full documentation of
+modules and functions, can be found [here](https://rngkomorebi.github.io/daplis/).
+
+Some functions (mainly the plotting ones) save plots as pictures in the
+.png format, creating a folder for the output in the same folder that
+holds the data. Others (such as delta_t.py for collecting timestamp differences
+in the given time window) save .csv or .feather files with the processed data for
+easier and faster plotting.
+
+Additionally, a standalone repo with an application for online plotting
+of the sensor population can be found [here](https://github.com/rngKomorebi/LinoSPAD2-app).
+
+## Installation and usage
+
+A fresh, separate virtual environment is highly recommended before installing the package.
+This can be done using pip, see, e.g., [this](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/).
+This can help to avoid any dependency conflicts and ensure smooth operation of the
+package.
+
+First, check if the virtualenv package is installed. To do this, one can run:
+```
+pip show virtualenv
+```
+If the package was not found, it can be installed using:
+```
+pip install virtualenv
+```
+To create a new environment, run the following:
+```
+virtualenv PATH/TO/NEW/ENVIRONMENT
+```
+To activate the environment (on Windows):
+```
+PATH/TO/NEW/ENVIRONMENTScripts/activate
+```
+and on Linux:
+```
+source PATH/TO/NEW/ENVIRONMENTbin/activate
+```
+
+Then, package itself can be installed using pip inside the environment:
+```
+pip install daplis
+```
+
+Alternatively, to start using the package, one can download the whole repo. "requirements.txt" 
+lists all packages required for this project to run. One can create 
+an environment for this project either using conda or pip following the instruction 
+above. Once the new environmnt is activated, run the following to install 
+the required packages:
+```
+cd PATH/TO/GITHUB/CODES/daplis
+pip install -r requirements.txt
+```
+Now, the package can be installed via
+```
+pip install -e .
+```
+where '-e' stands for editable: any changes introduced to the package will
+instantly become a part of the package and can be used without the need
+of reinstalling the whole thing. After that, one can import any function 
+from the daplis package:
+```
+from daplis.functions import sensor_plot, delta_t, fits
+```
+
+For conda users, the new environment can be installed using the 'requirements' 
+text file directly:
+```
+conda create --name NEW_ENVIRONMENT_NAME --file /PATH/TO/requirements.txt -c conda-forge
+```
+To install the package, first, switch to the created environment:
+```
+conda activate NEW_ENVIRONMENT_NAME
+```
+and run
+```
+pip install -e .
+```
+
+For a fast introduction on how to use the package, please see the
+jupyter notebooks with examples on the main functions at "daplis/examples/".
+
+## How to contribute
+
+This repo consists of two branches: 'main' serves as the release version
+of the package, tested, proven to be functional, and ready to use, while
+the 'develop' branch serves as the main hub for testing new stuff. To
+contribute, the best way would be to fork the repository and use the 'develop'
+branch for new introductions, submitting the results via pull requests. 
+Everyone willing to contribute is kindly asked to follow the 
+[PEP 8](https://peps.python.org/pep-0008/) and 
+[PEP 257](https://peps.python.org/pep-0257/) conventions.
+
+## License and contact info
+
+This package is available under the MIT license. See LICENSE for more
+information. If you'd like to contact me, the author, feel free to
+write at sergei.kulkov23@gmail.com.

daplis-1.1.1/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools>=70.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "daplis"
+version = "1.1.1"
+description = "Data Analysis Package for LInoSpad"
+authors = [{ name = "Sergei Kulkov", email = "sergei.kulkov23@gmail.com" }]
+license = { text = "MIT" }
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+keywords = ["timestamp", "analysis", "LinoSPAD2"]
+
+dependencies = [
+    "lmfit>=0.9.1",
+    "matplotlib>=3.5.0",
+    "numpy>=1.22.4",
+    "pandas>=1.4.0",
+    "pyarrow>=17.0.0",
+    "scipy>=1.7.0",
+    "seaborn>=0.9.0",
+    "tqdm>=4.67.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+daplis = ["*.txt", "*.csv"]
+
+[project.urls]
+Homepage = "https://github.com/rngKomorebi/daplis"

daplis-1.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+