File	Date	Author	Commit
cmake_modules	2015-08-20	tehuser	[09460e] * Add missing typesize check
data	2019-11-17	tehuser	[a8f9f8] * Fix typos in natural abdundance
doc	2020-05-22	tehuser	[30712b] * typos
example	2023-05-10	D Haley	[e16008] cppcheck fixes - Mostly unused variables
extras	2017-11-22	tehuser	[8e5882] * Fix resource leak
include	2023-05-10	D Haley	[e16008] cppcheck fixes - Mostly unused variables
packaging	2021-02-16	D Haley	[6a8d37] * Update debian packaging
src	2023-05-10	D Haley	[13182e] Change LFSR to assume (but static assert) sizeo...
swig	2020-07-03	D Haley	[eb28c8] * Add quaternion rotation and lsfr code to swig...
test	2023-05-10	D Haley	[6339b4] Fix clang warnings
testdata	2020-11-25	D Haley	[0e7e38] * Add APT-HDF5 test
.build.yml	2019-08-20	tehuser	[ac5a88] * Add .build.yml for sourcehut
.hgignore	2014-11-21	D Haley	[97e6c0] * Move data
AUTHORS	2014-11-20	tehuser	[f84c1a] * Add example
CMakeLists.txt	2023-10-08	tehuser	[11cd15] Disable qhull by default
COPYING	2014-11-20	tehuser	[f84c1a] * Add example
README.txt	2021-11-27	D Haley	[703e14] Add readme
test.sh	2023-10-02	tehuser	[94faa0] Manually set library path before running unit t...

Read Me

libatomprobe : a library for atom probe computation

This library provides common operations and algorithms for atom probe
tomography (APT), as well as routines for reading and writing common
atom probe file formats. The library is written in C++, and can be used
from C++ or python

The library is free (libre) software, licenced under the GPLv3+, and
can be copied and used under those (fairly liberal) terms. No guarantees
of correctness or completeness are given, but we try our best!

You can find the following (not a complete list)
- fast nearest neighbour searching
- Clustering
- Deconvolution/decomposition of overlapping masses
- RNG/RRNG/ENV/POS/ATO/OPS/APTHDF5/APT Read/write (not all have write)
- Simple geometric reconstruction
- Stereogram/projection and inverse support
- Axial/spatial distribution calulations
- Convex hull calculations
- Geometric transforms
- Isotope intensity reference calculations
- Range explained-fraction
- Background noise fitting and removal
- Confidence limit 

To compile, we require:
* A C++ compiler, supporting C++11 or later
* CMake
* libxml2
* Qhull >2009
* libgsl

Optionally:
* If using python, the "swig" interface generator
* For APTHDF5 support, libhdf5


To build from source code under Debian/Ubuntu, where $ indicates a
command to be entered at the command prompt:
* install the following via apt, e.g. 
  $  sudo apt install libxml2-dev libqhull-dev libgsl-dev cmake

* run cmake (you might want to look at CMakeLists.txt to change some options)
  $ cmake . -DRelease

If you find a bug in this library, please email : mycae - gmx - com,
to report any issues you encounter.