Contents Menu Expand
libgunshotmatch 1.0.0 documentation
libgunshotmatch 1.0.0 documentation
  • Home

API Reference

  • libgunshotmatch.comparison
  • libgunshotmatch.consolidate
  • libgunshotmatch.datafile
  • libgunshotmatch.gzip_util
  • libgunshotmatch.method
  • libgunshotmatch.peak
  • libgunshotmatch.project
  • libgunshotmatch.search
  • libgunshotmatch.utils

Contributing

  • Contributing
  • Downloading source code
  • License

Links

  • GitHub
  • PyPI

libgunshotmatch¶

Base library for GunShotMatch.

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status

Installation¶

python3 -m pip install libgunshotmatch --user
python3 -m pip install git+https://github.com/GunShotMatch/libgunshotmatch@master --user

Contents¶

API Reference

  • libgunshotmatch.comparison
    • align_projects
    • get_padded_peak_lists
    • libgunshotmatch.comparison.projects
    • libgunshotmatch.comparison.unknowns
  • libgunshotmatch.consolidate
    • ConsolidatedPeak
    • ConsolidatedPeakFilter
    • InvertedFilter
    • ConsolidatedSearchResult
    • combine_spectra
    • match_counter
    • pairwise_ms_comparisons
  • libgunshotmatch.datafile
    • Datafile
    • FileType
    • GCMSDataInfo
    • Repeat
    • get_info_from_gcms_data
  • libgunshotmatch.gzip_util
    • read_gzip_json
    • write_gzip_json
  • libgunshotmatch.method
    • Method
    • IntensityMatrixMethod
    • PeakDetectionMethod
    • PeakFilterMethod
    • AlignmentMethod
    • ConsolidateMethod
    • SavitzkyGolayMethod
  • libgunshotmatch.peak
    • PeakList
    • QualifiedPeak
    • QualifiedPeakList
    • align_peaks
    • base_peak_mass
    • filter_aligned_peaks
    • filter_peaks
    • peak_from_dict
    • write_alignment
    • write_project_alignment
  • libgunshotmatch.project
    • Project
    • consolidate
  • libgunshotmatch.search
    • identify_peaks
  • libgunshotmatch.utils
    • create_alignment
    • get_rt_range
    • get_truncated_normal
    • ms_comparison
    • round_rt

Contributing

  • Contributing
    • Coding style
    • Automated tests
    • Type Annotations
    • Build documentation locally
  • Downloading source code
    • Building from source
  • License

View the Function Index or browse the Source Code.

Browse the GitHub Repository

Next
libgunshotmatch.comparison
Copyright © 2020-2023 Dominic Davis-Foster | Built with Sphinx and @pradyunsg's Furo theme. | Show Source
Contents
  • libgunshotmatch
    • Installation
    • Contents