SandiaSpecUtils 0.0.10__tar.gz

sandiaspecutils-0.0.10/CMakeLists.txt

@@ -0,0 +1,93 @@
+cmake_minimum_required(VERSION 3.15...3.26)
+
+project(SpecUtils_py LANGUAGES CXX)
+
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+set( SpecUtils_ENABLE_D3_CHART ON CACHE BOOL "" )
+set( SpecUtils_D3_SUPPORT_FILE_STATIC ON CACHE BOOL "" )
+set( SpecUtils_PYTHON_BINDINGS ON CACHE BOOL "Build the python bindings" )
+set( SpecUtils_ENABLE_EQUALITY_CHECKS OFF CACHE BOOL "" )
+set( PERFORM_DEVELOPER_CHECKS OFF CACHE BOOL "" )
+set( SpecUtils_SHARED_LIB OFF CACHE BOOL "" )  #we'll statically link SpecUtils into the lib we create here
+set( SpecUtils_FLT_PARSE_METHOD "strtod" CACHE STRING "Float parsing method" )
+
+# Enable URI spectra for macOS and Linux (since we are already linking to zlib), but not Windows
+if(WIN32)
+  set( SpecUtils_ENABLE_URI_SPECTRA OFF CACHE BOOL "" )
+else()
+  set( SpecUtils_ENABLE_URI_SPECTRA ON CACHE BOOL "" )
+endif()
+
+add_subdirectory( ${CMAKE_CURRENT_SOURCE_DIR}/../.. ${CMAKE_CURRENT_BINARY_DIR}/LibSpecUtils )
+
+if (NOT SKBUILD)
+  message(FATAL_ERROR "\
+  This CMake file is must be executed using 'scikit-build'. 
+  If you are a user trying to install this package, please use the command
+  below, which will install all necessary build dependencies, compile
+  the package in an isolated environment, and then install it.
+  =====================================================================
+   $ pip install .
+  =====================================================================
+  If you are a software developer, and this is your own package, then
+  it is usually much more efficient to install the build dependencies
+  in your environment once and use the following command that avoids
+  a costly creation of a new virtual environment at every compilation:
+  =====================================================================
+   $ pip install nanobind scikit-build-core
+   $ pip install --no-build-isolation -ve .
+  =====================================================================
+  You may optionally add -Ceditable.rebuild=true to auto-rebuild when
+  the package is imported. Otherwise, you need to re-run the above
+  after editing C++ files.")
+endif()
+
+# Try to import all Python components potentially needed by nanobind
+find_package(Python 3.8
+  REQUIRED COMPONENTS Interpreter Development.Module
+  OPTIONAL_COMPONENTS Development.SABIModule)
+
+# Import nanobind through CMake's find_package mechanism
+find_package(nanobind CONFIG REQUIRED)
+
+# We are now ready to compile the actual extension module
+nanobind_add_module(
+  # Name of the extension
+  PySpecUtils
+
+  # Target the stable ABI for Python 3.12+, which reduces
+  # the number of binary wheels that must be built. This
+  # does nothing on older Python versions
+  STABLE_ABI
+
+  # Build libnanobind statically and merge it into the
+  # extension (which itself remains a shared library)
+  #
+  # If your project builds multiple extensions, you can
+  # replace this flag by NB_SHARED to conserve space by
+  # reusing a shared libnanobind across libraries
+  NB_STATIC
+
+  #Perform link time optimization.
+  #LTO
+
+
+  # Source code goes here
+  SpecFile_py.cpp
+)
+
+set_target_properties( PySpecUtils PROPERTIES OUTPUT_NAME "SpecUtils" )
+target_link_libraries( PySpecUtils PUBLIC SpecUtils )
+
+# Install directive for scikit-build-core
+install(TARGETS PySpecUtils LIBRARY DESTINATION SpecUtils)
+install(FILES __init__.py DESTINATION SpecUtils) 
+
+nanobind_add_stub(
+  SpecUtils_stub
+    MODULE SpecUtils
+    OUTPUT SpecUtils.pyi
+    PYTHON_PATH $<TARGET_FILE_DIR:PySpecUtils>
+    DEPENDS PySpecUtils
+)

sandiaspecutils-0.0.10/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.1
+Name: SandiaSpecUtils
+Version: 0.0.10
+Summary: Python bindings for SpecUtils using nanobind and scikit-build
+Author-Email: Will Johnson <wcjohns@sandia.gov>
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
+Project-URL: Homepage, https://github.com/sandialabs/SpecUtils
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# Gamma Spectrum file utilities
+
+[SpecUtils](https://github.com/sandialabs/SpecUtils) is a library for reading, manipulating, and exporting spectrum files produced by RadioIsotope Identification Devices (RIIDs), Radiation Portal Monitors (RPMs), radiation search systems, Personal Radiation Detectors (PRDs), and many laboratory detection systems.
+It opens [N42](https://www.nist.gov/programs-projects/ansiieee-n4242-standard) (2006 and 2012 formats), [SPE](https://inis.iaea.org/collection/NCLCollectionStore/_Public/32/042/32042415.pdf), [SPC](https://web.archive.org/web/20160418031030/www.ortec-online.com/download/ortec-software-file-structure-manual.pdf), CSV, TXT, [PCF](https://www.osti.gov/biblio/1378172-pcf-file-format), [DAT](https://www.aseg.org.au/sites/default/files/gr-135.pdf), and many more files; altogether much more than a 100 file format variants.  This library lets you either programmatically access and/or modify the parsed information, or you can save it to any of 13 different formats, or create spectrum files from scratch.
+
+
+This package is a Python wrapper around the C++ [SpecUtils](https://github.com/sandialabs/SpecUtils) library, with the bindings created using [nanobind](https://github.com/wjakob/nanobind).  [SpecUtils](https://github.com/sandialabs/SpecUtils) is primarily developed as part of [InterSpec](https://github.com/sandialabs/InterSpec/), but is also used by [Cambio](https://github.com/sandialabs/Cambio/), and a number of other projects.
+
+An example use is:
+```python
+import SpecUtils
+
+# Create a SpecFile object
+spec = SpecUtils.SpecFile()
+
+# Load a spectrum file
+spec.loadFile("spectrum_file.n42", SpecUtils.ParserType.Auto)
+
+# Get list of all individual records in the spectrum file
+meass = spec.measurements() 
+print( "There are", len(meass), "spectrum records." )
+
+# Get first measurement
+meas = meass[0]
+
+# Get gamma counts, and the lower energy of each channel
+counts = meas.gammaCounts()
+energies = meas.channelEnergies()
+
+# Get neutron counts
+neutrons = meas.neutronCountsSum()
+
+# Get start time
+startime = meas.startTime()
+
+# Print out CSV information of energies and counts
+print( "StartTime: ", startime )
+print( "Neutron counts: ", neutrons, "\n" )
+print( "Energy (keV), Counts" )
+for i in range(len(counts)):
+    print( f"{energies[i]},{counts[i]}" )
+```
+
+For further examples, see the [examples](https://github.com/sandialabs/SpecUtils/tree/master/bindings/python/examples) directory.
+To run the examples, run the following commands:
+```
+python test_python.py
+python make_file_example.py
+python make_html_plot.py /some/path/to/a/file.n42
+```
+
+
+## Installation
+You can install the package using pip like this:
+```
+mkdir my_venv
+python -m venv my_venv
+
+source my_venv/bin/activate
+pip install SandiaSpecUtils
+
+python
+>>> import SpecUtils
+>>> spec = SpecUtils.SpecFile()
+>>> ...
+```
+
+
+Or instead, you can compile from source yourself, with something like:
+```
+git clone https://github.com/sandialabs/SpecUtils.git SpecUtils
+
+# Optionsally make/use a virtual environment
+mkdir my_venv
+python3 -m venv my_venv
+source my_venv/bin/activate  # Windows PowerShell: .\my_venv\Scripts\Activate.ps1
+
+# Compile and install the bindings
+pip install --use-feature=in-tree-build SpecUtils/bindings/python
+
+# Use the package
+python
+>>> import SpecUtils
+```
+
+
+## Support
+Please create an issue on the [SpecUtils GitHub repository](https://github.com/sandialabs/SpecUtils/issues), or email InterSpec@sandia.gov if you have any questions or problems.

sandiaspecutils-0.0.10/README.md

@@ -0,0 +1,88 @@
+# Gamma Spectrum file utilities
+
+[SpecUtils](https://github.com/sandialabs/SpecUtils) is a library for reading, manipulating, and exporting spectrum files produced by RadioIsotope Identification Devices (RIIDs), Radiation Portal Monitors (RPMs), radiation search systems, Personal Radiation Detectors (PRDs), and many laboratory detection systems.
+It opens [N42](https://www.nist.gov/programs-projects/ansiieee-n4242-standard) (2006 and 2012 formats), [SPE](https://inis.iaea.org/collection/NCLCollectionStore/_Public/32/042/32042415.pdf), [SPC](https://web.archive.org/web/20160418031030/www.ortec-online.com/download/ortec-software-file-structure-manual.pdf), CSV, TXT, [PCF](https://www.osti.gov/biblio/1378172-pcf-file-format), [DAT](https://www.aseg.org.au/sites/default/files/gr-135.pdf), and many more files; altogether much more than a 100 file format variants.  This library lets you either programmatically access and/or modify the parsed information, or you can save it to any of 13 different formats, or create spectrum files from scratch.
+
+
+This package is a Python wrapper around the C++ [SpecUtils](https://github.com/sandialabs/SpecUtils) library, with the bindings created using [nanobind](https://github.com/wjakob/nanobind).  [SpecUtils](https://github.com/sandialabs/SpecUtils) is primarily developed as part of [InterSpec](https://github.com/sandialabs/InterSpec/), but is also used by [Cambio](https://github.com/sandialabs/Cambio/), and a number of other projects.
+
+An example use is:
+```python
+import SpecUtils
+
+# Create a SpecFile object
+spec = SpecUtils.SpecFile()
+
+# Load a spectrum file
+spec.loadFile("spectrum_file.n42", SpecUtils.ParserType.Auto)
+
+# Get list of all individual records in the spectrum file
+meass = spec.measurements() 
+print( "There are", len(meass), "spectrum records." )
+
+# Get first measurement
+meas = meass[0]
+
+# Get gamma counts, and the lower energy of each channel
+counts = meas.gammaCounts()
+energies = meas.channelEnergies()
+
+# Get neutron counts
+neutrons = meas.neutronCountsSum()
+
+# Get start time
+startime = meas.startTime()
+
+# Print out CSV information of energies and counts
+print( "StartTime: ", startime )
+print( "Neutron counts: ", neutrons, "\n" )
+print( "Energy (keV), Counts" )
+for i in range(len(counts)):
+    print( f"{energies[i]},{counts[i]}" )
+```
+
+For further examples, see the [examples](https://github.com/sandialabs/SpecUtils/tree/master/bindings/python/examples) directory.
+To run the examples, run the following commands:
+```
+python test_python.py
+python make_file_example.py
+python make_html_plot.py /some/path/to/a/file.n42
+```
+
+
+## Installation
+You can install the package using pip like this:
+```
+mkdir my_venv
+python -m venv my_venv
+
+source my_venv/bin/activate
+pip install SandiaSpecUtils
+
+python
+>>> import SpecUtils
+>>> spec = SpecUtils.SpecFile()
+>>> ...
+```
+
+
+Or instead, you can compile from source yourself, with something like:
+```
+git clone https://github.com/sandialabs/SpecUtils.git SpecUtils
+
+# Optionsally make/use a virtual environment
+mkdir my_venv
+python3 -m venv my_venv
+source my_venv/bin/activate  # Windows PowerShell: .\my_venv\Scripts\Activate.ps1
+
+# Compile and install the bindings
+pip install --use-feature=in-tree-build SpecUtils/bindings/python
+
+# Use the package
+python
+>>> import SpecUtils
+```
+
+
+## Support
+Please create an issue on the [SpecUtils GitHub repository](https://github.com/sandialabs/SpecUtils/issues), or email InterSpec@sandia.gov if you have any questions or problems.