Skip to main content

NAPS (NAPS is ArUco Plus SLEAP)

Project description

Stable version Latest version Documentation Status Continuous integration status Coverage conda Conda Upload PyPI Upload LICENSE

NAPS (NAPS is ArUco Plus SLEAP)

NAPS is a tool for researchers with two goals: (1) to quantify animal behavior over a long timescale and high resolution, with minimal human bias, and (2) to track the behavior of individuals with a high level of identity-persistence. This could be of use to researchers studying social network analysis, animal communication, task specialization, or gene-by-environment interactions. By combining deep-learning based pose estimation software with easily read and minimally invasive fiducial markers (“tags”), we provide an easy-to-use solution for producing high-quality, high-dimensional behavioral data.

Example usage of NAPS to track a colony of common eastern bumblebees.

Documentation

NAPS documentation can be found at naps.rtfd.io.

Features

  • Easy, direct installation across platforms

  • Built directly on top of OpenCV and SLEAP with a modular, extensible codebase

  • Flexible API that allows drop in of different methods for marker identification

  • Multiprocessing through Ray

Getting NAPS

Easy install

conda (Windows/Linux):

conda create -n naps naps-track -c kocherlab -c sleap -c nvidia -c conda-forge

pip (any OS):

pip install naps-track

References

If you use NAPS in your research, please cite:

S. W. Wolf, D. M. Ruttenberg*, D. Y. Knapp*, A. W. Webb, I. M. Traniello, G. C. McKenzie-Smith, J. W. Shaevitz, and S. D. Kocher. Hybrid tracking to capture dynamic social networks. In Prep, n.d.

BibTeX:

@UNPUBLISHED{Wolf_undated,
   author = {Wolf, Scott W and Ruttenberg, Dee M and Knapp, Daniel Y and Webb,
            Andrew E and Traniello, Ian M and McKenzie-Smith, Grace C and Shaevitz, Joshua W and Kocher, Sarah D},
   title = {Hybrid tracking to capture dynamic social networks},
   year = {n.d.}
}

Issues

Issues with NAPS?

  1. Check the docs.

  2. Search the issues on GitHub or open a new one.

Contributors

  • Scott Wolf, Lewis-Sigler Institute for Integrative Genomics, Princeton University

  • Dee Ruttenberg, Lewis-Sigler Institute for Integrative Genomics, Princeton University

  • Daniel Knapp, Department of Physics, Princeton University

  • Andrew Webb, Department of Ecology and Evolutionary Biology and Lewis-Sigler Institute for Integrative Genomics, Princeton University

  • Ian Traniello, Lewis-Sigler Institute for Integrative Genomics, Princeton University

  • Grace McKenzie-Smith, Department of Physics and Lewis-Sigler Institute for Integrative Genomics, Princeton University

  • Joshua Shaevitz, Department of Physics and Lewis-Sigler Institute for Integrative Genomics, Princeton University

  • Sarah Kocher, Department of Ecology and Evolutionary Biology and Lewis-Sigler Institute for Integrative Genomics, Princeton University

NAPS was created in the Kocher and Shaevitz labs at Princeton University.

License

NAPS is licensed under the MIT license. See the LICENSE file for details.

Acknowledgements

Much of the structure and content of the README and the documentation is borrowed from the SLEAP repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

naps-track-1.0.0.tar.gz (14.0 kB view details)

Uploaded Source

File details

Details for the file naps-track-1.0.0.tar.gz.

File metadata

  • Download URL: naps-track-1.0.0.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for naps-track-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6f43dd9e1bfc9d7464709a96d4fa7b89de9511506bef1d17703b223ebe9b4c42
MD5 e6c13e68e34a5acb332dddfa3f5b5261
BLAKE2b-256 ef8e66577d8b9caf687a6a3813c45c00b94545d61e9995dce8c6a37a8fceda6c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page