search

sandialabs / InterSpec

spectral radiation analysis software
https://sandialabs.github.io/InterSpec
GNU Lesser General Public License v2.1
129 stars 21 forks source link
scr-2173 snl-applications snl-data-analysis snl-visualization

readme

Tests App Build

InterSpec

InterSpec is a native or web application to assist in analyzing spectral nuclear radiation data, using a peak-based methodology. Common uses include identifying nuclides present, determining source activity, shielding amounts, source age, or other nuclear reactions present. InterSpec also provides a number of other tools useful for analyzing radiation data including spectral file format converting, dose rate calculations, interactive nuclide decay and reference information, gamma cross section calculations, and more. InterSpec can open data files from most common spectral radiation detectors (e.g., most NaI, HPGe, LaBr, CLYC, CsI, etc. based systems) and assist in their analysis. InterSpec can also be built as a stand-alone (e.g., no Internet connection necessary) native app (using either OS provided WebView, or Electron for display) for Windows, Linux, macOS, iOS, or Android.

Getting Started

For executable installation:

A brief getting started guide can be found in brief_ana_overview_InterSpec_Oct2018.pdf; a more comprehensive tutorial is planned for the future.

Release notes, tutorials, and example problems can be found at https://sandialabs.github.io/InterSpec/releases/.

Some Screen Shots

W187 peak fit example

Interactions with the chart are fast and natural. Peak fitting is as easy as double clicking where you want a peak fit, or there is an automated option that is especially useful for HPGe detectors.

Activity Fit Tool

Can fit for activities and shielding for multiple nuclides at once, taking into account interferences, ages, self-attenuation, etc. A large shielding database is included, or generic shielding can be used.

Ho166m and Eu152 peak fit example

Easily fit overlapping peaks. Photopeak sources are assigned to peaks for easy activity/shielding fitting or energy calibration.

Nuclear decay chart

Includes an extensive database of nuclides. Nuclide aging is performed on-the-fly throughout the app to allow adjusting or fitting for ages.

Nuclear decay chain Lots of useful tools.

Nuclide identification by energy

Searching for nuclides by energy, by default, takes into acount peak amplitudes and other peaks in the spectrum (even if you havent fit for them) to order results in an intelligent way.

Dose calculation example

You can go from source activity to dose, or from measured dose to source activity, or shielding amount.

Building from source

If you would like to build the app, some instructions are below.

If you are developer of radiation analysis software, there is, in particular some code that may be useful for you:

  1. sandia_decay: This small library reads in sandia.decay.xml and allows you to retrieve the half-lives, xrays, gammas, alpha, betas, etc given off by any certain nuclide, or you can easily decay nuclides and find activities of the decay chain nuclides, the particles that will be given off at any time, and more. An emphasis is placed on easy to use, but computationally efficient code.
  2. SpecUtils: If you have to read in spectral files, including N42, PCF, SPC, DAT, CHN, etc., this library may do what you want. It decodes many file format variants, and saves to about a dozen different formats. This library can be called from c++, Python, or Java, or if you want a very simple gui to do this, or a command line application, check out cambio (which is powered by this library).

Prerequisites

At a minimum, you will need a C++14 compiler, and cmake.

Then to build, you can choose one of two methods to build the code:

  1. Use cmake to fetch and build the prerequisites for you, by specifying the InterSpec_FETCH_DEPENDENCIES CMake option to ON. This option requires having git installed, but is generally the easier of the two options.
  2. Build the prerequisites yourself. This option is faster if you plan to rebuild the code many times, as CMake will have less libraries to deal with internally,. You will need to build the following libraries from source (see the instructions in the patches directory):
    • Wt version 3.7.1. Some patches are included in the patches directory.
    • boost version 1.78 is
    • The macOS app also requires libharu, and libpng.

Included in this repository are some additional C++ libraries that will be built as part of building InterSpecs code.
These libraries include Cuba, Minuit2, muparserx, QR Code generator library, pugixml and rapidxml, which are in the external_libs directory, while the js directory contains some ECMAScript libraries, including jQuery, qTip2, and D3.

Additionally for the Windows or Electron application build, you will need npm installed to create the application package (see the electron directory for build instructions).

Building

After compiling boost and Wt from source, clone the InterSpec repository, and from the terminal, run cmake:

git clone --recursive https://github.com/sandialabs/interspec/
cd interspec
mkdir build
cd build
cmake ..

If you are on Windows, or prefer a GUI, running the CMake for building InterSpec should be like most other CMake project; you will probably have to fill in paths to boost and Wt manually. Or if you have boost or Wt in a non-standard location, you can use a command like:

cmake -DCMAKE_PREFIX_PATH=/path/to/prefix ..

or if boost and Wt are in different directories:

cmake -generator "Visual Studio 15 2017 Win64" \
      -DBOOST_ROOT=/path/to/boost \
      -DWt_INCLUDE_DIR=/path/to/wt/include \
      -DCMAKE_MSVC_RUNTIME_LIBRARY="MultiThreaded$<$<CONFIG:Debug>:Debug>" \
      -DBoost_USE_STATIC_LIBS=OFF \
      -DBoost_USE_STATIC_RUNTIME=ON \
      ..

And then make:

make -j8
# or
cmake --build . --config Release

If all goes well, InterSpec default to building an executable that when ran from the command line, starts a local web server, you can access then access from your browser. To run InterSpec, use a command like:

./bin/InterSpec.exe --docroot . --http-address 127.0.0.1 --http-port 8080 -c ./data/config/wt_config_localweb.xml

and then point your browser to http://localhost:8080.

If you would like build as a native-ish app, see the BUILD_AS_OSX_APP, or BUILD_AS_ELECTRON_APP CMake options, as well as the electron directory for the latter. For building as a WebApp behind something like nginx or apache, see BUILD_FOR_WEB_DEPLOYMENT, but please note that InterSpec is not developed for general internet deployments, so there is likely many issues you would need to consider or address before exposing to untrusted users. There are also a number of CMake options available to control which features get included in InterSpec.

Building for iOS and Android are both possible (see the target directory), and these instructions will be updated in the future.

Authors

Ethan Chan, William Johnson, David Ka-Ming Lee, Christian Morte, with extensive additional support provided by Noel Nachtigal and Edward Walsh.

License

This project is licensed under the LGPL v2.1 License - see the LICENSE.md file for details

Copyright

Copyright 2018 National Technology & Engineering Solutions of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.

Disclaimer

DISCLAIMER OF LIABILITY NOTICE:
The United States Government shall not be liable or responsible for any maintenance,
updating or for correction of any errors in the SOFTWARE or subsequent approved version
releases.

THE INTERSPEC (SOFTWARE) AND ANY OF ITS SUBSEQUENT VERSION
RELEASES, SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF
ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT
NOT LIMITED TO, ANY WARRANTY THAT THE SOFTWARE WILL CONFORM TO
SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY
WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY
THAT THE DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE
SOFTWARE. IN NO EVENT SHALL THE UNITED STATES GOVERNMENT OR ITS
CONTRACTORS OR SUBCONTRACTORS BE LIABLE FOR ANY DAMAGES,
INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL OR
CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR IN ANY
WAY CONNECTED WITH THE SOFTWARE OR ANY OTHER PROVIDED
DOCUMENTATION, WHETHER OR NOT BASED UPON WARRANTY, CONTRACT,
TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY
PERSONS OR PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS
SUSTAINED FROM, OR AROSE OUT OF THE RESULT OF, OR USE OF, THE
SOFTWARE OR ANY PROVIDED DOCUMENTATION. THE UNITED STATES
GOVERNMENT DISCLAIMS ALL WARRANTIES AND LIABILITIES REGARDING
THIRD PARTY SOFTWARE, IF PRESENT IN THE SOFTWARE, AND DISTRIBUTES
IT "AS IS."

Acknowledgement

This InterSpec Software was developed with funds from the Science and Technology Directorate of the Department of Homeland Security.

Privacy Policy

InterSpec apps built by Sandia National Laboratories, do not collect any personal information.

InterSpec locally stores preferences you may change in the app as well as spectra you load, explicitly saved states, and the app state when it is exited. This information does not leave your device, and can be deleted by removing the application data folder in the operating system's standard location for the app.

The only time external network communications is used by InterSpec is when the Map Tool is used, in which case it is only used to request map tiles from https://arcgisonline.com. Users will be warned before doing this, and there is an option to use your own arcgisonline.com account to request the the map tiles under (see the in-app Map Tools help for more information).