ParticleTracker

ParticleTracker: a gui based particle tracking software - Published in JOSS (2021)

https://github.com/mikesmithlabteam/particletracker

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Mathematics Computer Science - 84% confidence
Last synced: 6 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: MikeSmithLabTeam
  • License: mit
  • Language: Python
  • Default Branch: master
  • Size: 94.9 MB
Statistics
  • Stars: 5
  • Watchers: 0
  • Forks: 4
  • Open Issues: 4
  • Releases: 6
Created over 5 years ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License

README.md

ParticleTracker

ParticleTracker is a gui based particle tracking software that brings together a range of tools to make particle tracking simple. Full details on installation and use can be found in the documentation:

Examples of tracked data created using ParticleTracker

Documentation

https://particle-tracker.readthedocs.io/en/master/

Video Tutorials

Youtube Playlist of Tutorials

Installation from github

Full details in documentation but in brief:

Create a new Conda environment: conda create -n pt and then install these packages in this order.

conda install pytables
conda install pyqt
conda install git  
pip install git+https://github.com/MikeSmithLabTeam/particletracker
pip install legacy-cgi

Updating if already installed

pip install --upgrade git+https://github.com/MikeSmithLabTeam/particletracker

To add as a dependency to another pip repository

Add the following argument to setup.py setuptools.setup()

dependency_links=['https://github.com/MikeSmithLabTeam/particletracker/tarball/repo/master#egg=package-1.0'],

Citation

To cite this project in your publications please cite the following paper: "ParticleTracker: a gui based particle tracking software" M.I. Smith, J.G. Downs, J. Open Source Software 6, 3611 (2021)

Markdown: DOI

Contributions

Details about contributing to the ParticleTracker project can be found here

Licensing

This project is licensed under the terms of the MIT licence (https://github.com/MikeSmithLabTeam/particletracker/blob/master/license.txt).

Owner

  • Name: MikeSmithLabTeam
  • Login: MikeSmithLabTeam
  • Kind: organization

JOSS Publication

ParticleTracker: a gui based particle tracking software
Published
October 26, 2021
Volume 6, Issue 66, Page 3611
Authors
Mike I. Smith ORCID
School of Physics, University of Nottingham, UK, NG7 2RD
James G. Downs
School of Physics, University of Nottingham, UK, NG7 2RD
Editor
Kevin M. Moerman ORCID
Tags
particle tracking

GitHub Events

Total
  • Issues event: 5
  • Watch event: 1
  • Issue comment event: 3
  • Push event: 18
  • Create event: 1
Last Year
  • Issues event: 5
  • Watch event: 1
  • Issue comment event: 3
  • Push event: 18
  • Create event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 490
  • Total Committers: 5
  • Avg Commits per committer: 98.0
  • Development Distribution Score (DDS): 0.098
Past Year
  • Commits: 25
  • Committers: 2
  • Avg Commits per committer: 12.5
  • Development Distribution Score (DDS): 0.16
Top Committers
Name Email Commits
Mike Smith m****b@g****m 442
James j****b@g****m 29
PPYOL1 p****1@n****k 13
JamesDownsLab 4****b 5
Daniel S. Katz d****z@i****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 24
  • Total pull requests: 3
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 12 hours
  • Total issue authors: 5
  • Total pull request authors: 2
  • Average comments per issue: 1.17
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 0
  • Average time to close issues: 11 days
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.43
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mikesmithlab (9)
  • nkeim (8)
  • JamesDownsLab (3)
  • alexlib (3)
  • OliverLunn (1)
Pull Request Authors
  • mikesmithlab (2)
  • danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

docs/requirements.txt pypi
  • PyQt5 *
  • sphinx >=4.2.0
pyproject.toml pypi
  • filehandling @ git+https://github.com/MikeSmithLabTeam/filehandling
  • labvision @ git+https://github.com/MikeSmithLabTeam/labvision
  • matplotlib *
  • moviepy *
  • numpy *
  • opencv-python *
  • pandas *
  • pillow *
  • qimage2ndarray *
  • qtwidgets @ git+https://github.com/MikeSmithLabTeam/qtwidgets
  • scipy *
  • slicerator *
  • sphinx >=4.0
  • sphinx-autobuild >=2021.3.14
  • sphinx-rtd-theme >=1.2.0
  • tables *
  • tqdm *
  • trackpy *
environment.yml conda
  • blas 1.0
  • blosc 1.21.3
  • bottleneck 1.3.5
  • brotli 1.0.9
  • brotli-bin 1.0.9
  • brotli-python 1.0.9
  • bzip2 1.0.8
  • c-blosc2 2.8.0
  • ca-certificates 2023.7.22
  • certifi 2023.7.22
  • charset-normalizer 3.2.0
  • colorama 0.4.6
  • contourpy 1.0.5
  • cycler 0.11.0
  • decorator 5.1.1
  • exceptiongroup 1.0.4
  • ffmpeg 4.3.1
  • fonttools 4.25.0
  • freetype 2.12.1
  • giflib 5.2.1
  • glib 2.69.1
  • hdf5 1.12.1
  • icc_rt 2022.1.0
  • icu 58.2
  • idna 3.4
  • imageio 2.31.1
  • imageio-ffmpeg 0.4.9
  • iniconfig 1.1.1
  • intel-openmp 2023.1.0
  • jpeg 9e
  • kiwisolver 1.4.4
  • krb5 1.20.1
  • lerc 3.0
  • libbrotlicommon 1.0.9
  • libbrotlidec 1.0.9
  • libbrotlienc 1.0.9
  • libclang 14.0.6
  • libclang13 14.0.6
  • libdeflate 1.17
  • libffi 3.4.4
  • libiconv 1.16
  • libpng 1.6.39
  • libpq 12.15
  • libtiff 4.5.1
  • libwebp 1.3.2
  • libwebp-base 1.3.2
  • libxml2 2.10.4
  • libxslt 1.1.37
  • looseversion 1.3.0
  • lz4-c 1.9.4
  • lzo 2.10
  • matplotlib 3.7.2
  • matplotlib-base 3.7.2
  • mkl 2023.1.0
  • mkl-service 2.4.0
  • mkl_fft 1.3.8
  • mkl_random 1.2.4
  • moviepy 1.0.3
  • munkres 1.1.4
  • numexpr 2.8.4
  • numpy 1.25.2
  • numpy-base 1.25.2
  • openssl 3.0.10
  • packaging 23.1
  • pandas 2.0.3
  • pcre 8.45
  • pexpect 4.8.0
  • pillow 9.4.0
  • pip 23.2.1
  • pluggy 1.0.0
  • ply 3.11
  • proglog 0.1.9
  • ptyprocess 0.7.0
  • py-cpuinfo 8.0.0
  • pyparsing 3.0.9
  • pyqt 5.15.7
  • pyqt5-sip 12.11.0
  • pysocks 1.7.1
  • pytables 3.8.0
  • pytest 7.4.0
  • python 3.10.13
  • python-dateutil 2.8.2
  • python-tzdata 2023.3
  • python_abi 3.10
  • pytz 2023.3.post1
  • pywin32 305
  • pyyaml 6.0
  • qt-main 5.15.2
  • qt-webengine 5.15.9
  • qtwebkit 5.212
  • requests 2.31.0
  • scipy 1.11.1
  • setuptools 68.0.0
  • sip 6.6.2
  • six 1.16.0
  • slicerator 1.0.0
  • sqlite 3.41.2
  • tbb 2021.8.0
  • tk 8.6.12
  • toml 0.10.2
  • tomli 2.0.1
  • tornado 6.3.2
  • tqdm 4.66.1
  • trackpy 0.6.1
  • tzdata 2023c
  • urllib3 2.0.5
  • vc 14.2
  • vs2015_runtime 14.27.29016
  • wheel 0.38.4
  • win_inet_pton 1.1.0
  • xz 5.4.2
  • yaml 0.2.5
  • zlib 1.2.13
  • zlib-ng 2.0.7
  • zstd 1.5.5