dustrack 1.0.0__tar.gz

dustrack-1.0.0/.gitignore

@@ -0,0 +1,166 @@
+.vscode/*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv-dev
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# AI workflow context (auto-loaded by Claude Code; kept local to avoid exposing private repo refs)
+CLAUDE.md

dustrack-1.0.0/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

dustrack-1.0.0/.idea/DUSTrack.iml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="PyDocumentationSettings">
+    <option name="format" value="GOOGLE" />
+    <option name="myDocStringFormat" value="Google" />
+  </component>
+</module>

dustrack-1.0.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

dustrack-1.0.0/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value=".deeplabcut3venv" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="deeplabcut3.13" project-jdk-type="Python SDK" />
+</project>

dustrack-1.0.0/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

dustrack-1.0.0/.readthedocs.yaml

@@ -0,0 +1,29 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

dustrack-1.0.0/CHANGELOG.md

@@ -0,0 +1,110 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2026-05-17
+
+Audit-and-polish release. No public API changes. Drops the alpha tag,
+re-points the README + bibtex from the arXiv preprint to the published
+*Scientific Reports* paper (Namburi et al., 2026,
+[doi:10.1038/s41598-026-42795-3](https://doi.org/10.1038/s41598-026-42795-3),
+accepted 2026-02-27), and folds in mechanical cleanup along the lines
+of datanavigator 1.2.0. The `numpy<2` pin and `<=3.13` upper bound stay
+in place — both are slated for relaxation in a CI-gated follow-up.
+
+### Fixed
+- `dustrack/dlcinterface.py`: removed a duplicate
+  `from skimage import io, img_as_ubyte` that was masked by the first
+  import a few lines up.
+- `dustrack/dlcinterface.py`: the ImportError path for missing
+  `deeplabcut` now calls `warnings.warn(...)` instead of `print(...)`,
+  so library import no longer writes unsolicited text to stdout when
+  `HAS_DLC=False`.
+- `dustrack/dlcinterface.py`: `process_dlc_project` had an
+  `assert self._dlcproject is not None` immediately followed by an
+  `if self._dlcproject is None: raise ValueError(...)`; the assert was
+  unreachable and has been dropped. The `ValueError` branch is now also
+  evaluated *before* `plt.close(self.figure)` so a stale-state caller
+  doesn't lose its figure.
+- `dustrack/dlcinterface.py`: removed four leftover developer-debug
+  `print` calls (`from_video` h5 path, `copy_annotations` filename,
+  `process` iteration counters, `annotate` video name). User-facing
+  status prints in extraction / training / merge paths are unchanged.
+- `dustrack/postprocess.py`: `lk_moving_average_filter` docstring no
+  longer contradicts the signature — `video_name` is documented as
+  optional with the path-argument requirement asserted at call time.
+
+### Changed
+- `dustrack/dlcinterface.py`: import-alias hygiene per the portfolio
+  convention settled 2026-05-13/14 — `from pyfilemanager import
+  FileManager` → `import pyfilemanager`; `import datanavigator` →
+  `import datanavigator as dnav`. Stdlib imports (`re`, `warnings`,
+  `PureWindowsPath`, `PurePosixPath`) are now grouped with the other
+  stdlib imports at the top of the module instead of trailing the
+  `try/except ImportError` block. No external API surface change.
+- `pyproject.toml`: dropped `Python :: 3.7` and `Python :: 3.8` from
+  the classifier list. The dependency stack (DLC3 + datanavigator
+  1.3.x + scientific Python) does not actually support either, and the
+  classifiers were misleading on PyPI. `requires-python = ">=3.7,
+  <=3.13"` is unchanged for this release (CI matrix + bound relaxation
+  is the next-band item).
+- `README.md`: citation paragraph and bibtex block now point at the
+  Nature *Scientific Reports* article rather than the arXiv preprint.
+- `docs/conf.py`: `release` bumped to `1.0.0`; stale `# pyfilemanager`
+  comment dropped.
+- `docs/index.md`: master-file comment header switched from
+  `pyfilemanager` (boilerplate copy-paste) to `dustrack`.
+
+## [1.0.0a2] - 2026-05-17
+
+Maintenance release. Fixes a packaging bug in 1.0.0a1 that silently
+disabled DeepLabCut integration on every fresh install from PyPI,
+swaps the video-reading backend from `decord` to
+`datanavigator.VideoReader` (PyAV+TOC), and ships the GUI / workflow
+additions accumulated since 1.0.0a1 (ultrasound image enhancement,
+dark theme, source-model wiring). No API breakage; the Qt rework
+slated for the next release lives on the `1.4.0-qt` branch and is
+not part of this release.
+
+### Fixed
+- `dustrack/dlcinterface.py`: removed the stale
+  `from . import imagesimilarity` import that landed inside the
+  `try`-import-`deeplabcut` block in 1.0.0a1. The `imagesimilarity`
+  module was never shipped to PyPI — it lives only on the
+  `wip/labeled-data-nudging` branch — so the import fell into
+  `except ImportError`, silently setting `HAS_DLC=False`, hiding
+  `DLCProject`, and disabling the `Create DLC Project` /
+  `Train DLC model` / `Reduce jitter` GUI buttons. Fresh PyPI installs
+  of 1.0.0a1 could not exercise the DLC pipeline at all.
+
+### Changed
+- Video reading now flows through `datanavigator.VideoReader`
+  (PyAV+TOC backend) instead of `decord`. The change rides
+  datanavigator 1.3.0's decord→PyAV+TOC swap; public reader API is
+  preserved (decord-shaped indexing, `get_batch([...]).asnumpy()`,
+  `len()`, iteration, `get_avg_fps()`). See the datanavigator 1.3.0
+  changelog for the parity-test motivation.
+- `datanavigator` pin: `>=1.3.0` → `>=1.3.0,<1.4.0`. Floor matches
+  the PyAV+TOC reader requirement; ceiling locks out the upcoming
+  datanavigator 1.4.0 Qt API, which the `1.4.0-qt` branch in this
+  repo targets as a separate forthcoming release.
+- Retired references to the internal NAS IP / hard-coded paths in
+  the dustrack module.
+
+### Added
+- `enhance_ultrasound_image()` helper in `dustrack/dlcinterface.py`
+  (CLAHE + gamma + brightness adjustments for B-mode ultrasound).
+- `DUSTrack` GUI: optional dark theme; gamma-correction toggle;
+  source-model path support for DLC project creation.
+- Documentation expansions in `dustrack/__init__.py` and the GUI
+  docstrings; Sphinx now picks up docstrings of optional components.
+
+### Removed
+- The `pia02_workflow/` directory has been moved off the `main`
+  branch into the `pia02-sandbox` branch (`git subtree split`, 63
+  commits of history preserved). The sandbox is technician-led
+  piano-study scratch (see `specs/dustrack.md` Open questions in the
+  pn-portfolio repo) and was not intended to live on `main`. It will
+  eventually graduate to `pn-projects/projects/mithic/pia02/`. This
+  is a repository-layout change only — the PyPI wheel never included
+  `pia02_workflow/` (flit scopes packaging to the `dustrack/` import
+  package), so installed-user behavior is unaffected.

dustrack-1.0.0/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Praneeth Namburi <praneeth.namburi@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

dustrack-1.0.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: dustrack
+Version: 1.0.0
+Summary: DUSTrack: Semi-automated point tracking in ultrasound videos.
+Keywords: video,tracking,computer-vision,motion-analysis,point-tracking
+Author-email: Praneeth Namburi <praneeth.namburi@gmail.com>
+Requires-Python: >=3.7,<=3.13
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE
+Requires-Dist: numpy<2
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Requires-Dist: portion
+Requires-Dist: ffmpeg-python
+Requires-Dist: tables
+Requires-Dist: dill
+Requires-Dist: tqdm
+Requires-Dist: scikit-image
+Requires-Dist: opencv-python
+Requires-Dist: pysampled
+Requires-Dist: pyfilemanager
+Requires-Dist: datanavigator>=1.3.0,<1.4.0
+Requires-Dist: sphinx==6.2.1 ; extra == "docs"
+Requires-Dist: sphinx-rtd-theme==2.0.0 ; extra == "docs"
+Requires-Dist: myst-parser==1.0.0 ; extra == "docs"
+Requires-Dist: sphinxcontrib-youtube==1.4.1 ; extra == "docs"
+Project-URL: Home, https://github.com/praneethnamburi/DUSTrack
+Provides-Extra: docs
+
+# DUSTrack
+
+[![src](https://img.shields.io/badge/src-github-blue)](https://github.com/praneethnamburi/DUSTrack)
+[![PyPI - Version](https://img.shields.io/pypi/v/DUSTrack.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/DUSTrack/)
+[![Documentation Status](https://readthedocs.org/projects/DUSTrack/badge/?version=latest)](https://DUSTrack.readthedocs.io)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/praneethnamburi/DUSTrack/main/LICENSE)
+
+*Semi-automated point tracking in videos. Designed for ultrasound videos, but works with natural videos as well.*
+
+`DUSTrack` (Deep learning and optical flow-based toolkit for UltraSound Tracking) is a semi-automated framework for tracking arbitrary points in B-mode ultrasound videos. It combines deep learning with optical flow to deliver high-quality, robust tracking across diverse anatomical structures and motion patterns. The toolkit includes a graphical user interface that streamlines the generation of high-quality training data and supports iterative model refinement. It also implements a novel optical-flow-based filtering technique that reduces high-frequency frame-to-frame noise while preserving rapid tissue motion.
+
+## Features
+
+- **Hybrid approach**: Combines deep learning with optical flow for accurate tracking
+- **User-friendly GUI**: Streamlines training data generation and model refinement
+- **Noise reduction**: Novel optical-flow-based filtering preserves rapid motion while reducing frame-to-frame noise
+- **Versatile**: Works with ultrasound and other video types
+- **Flexible installation**: Use GUI + optical flow only, or add deep learning capabilities
+
+Learn more about DUSTrack in our [paper in *Scientific Reports*](https://doi.org/10.1038/s41598-026-42795-3).
+
+## Installation
+
+### Option 1: GUI + Optical Flow Only (Recommended for Short Videos)
+
+For tracking points in videos with a few hundred frames, this lightweight installation is sufficient:
+
+```sh
+pip install DUSTrack
+```
+
+**Troubleshooting dependencies**: If you encounter dependency issues, use conda with the provided `requirements.yml` file:
+
+```sh
+conda env create -n env-dustrack -f https://github.com/praneethnamburi/DUSTrack/raw/main/requirements.yml
+conda activate env-dustrack
+pip install DUSTrack
+```
+
+### Option 2: Full Installation (Including Deep Learning)
+
+For longer videos or ultrasound videos with repetitive motions, deep learning significantly reduces manual effort and improves tracking quality:
+
+1. Create a conda environment and install DeepLabCut by following [these instructions](https://deeplabcut.github.io/DeepLabCut/docs/installation.html)
+2. Activate your DeepLabCut environment and install DUSTrack:
+   ```sh
+   conda activate <your-dlc-env>
+   pip install DUSTrack
+   ```
+
+## Quick Start
+
+```python
+from dustrack import DUSTrack
+import datanavigator
+
+# Launch the GUI with an example video
+video_path = datanavigator.get_example_video()  # or use your own video path
+d = DUSTrack(video_path, "pn") 
+# The second argument is the name of the "layer" for storing tracking annotations
+```
+
+**Next steps:**
+- Use the GUI to mark points of interest in your video (see [Keyboard shortcuts](https://github.com/praneethnamburi/DUSTrack/raw/main/docs/source/resources/keyboard_shortcuts.png))
+- Track points using optical flow and/or train a deep learning model
+- Export tracking results as a `.json` file for further analysis
+
+For detailed tutorials and examples, see the [documentation](https://DUSTrack.readthedocs.io).
+
+## Documentation
+
+Full documentation is available at [DUSTrack.readthedocs.io](https://DUSTrack.readthedocs.io).
+
+## Citation
+
+If you use DUSTrack in your research, please cite our paper:
+
+```bibtex
+@article{namburi2026dustrack,
+  title={DUSTrack: Semi-automated point tracking in ultrasound videos},
+  author={Namburi, Praneeth and Pallar{\`e}s-L{\'o}pez, Roger and Rosendorf, Jessica and Folgado, Duarte and Anthony, Brian W},
+  journal={Scientific Reports},
+  volume={16},
+  pages={13340},
+  year={2026},
+  doi={10.1038/s41598-026-42795-3}
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to:
+- Submit a Pull Request with improvements or bug fixes
+- Share your use cases and feedback ([contact](https://praneethnamburi.com/contact/))
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+[Praneeth Namburi](https://praneethnamburi.com)
+
+Project Link: [https://github.com/praneethnamburi/DUSTrack](https://github.com/praneethnamburi/DUSTrack)
+
+
+## Acknowledgments
+
+[MIT.nano Immersion Lab](https://immersion.mit.edu)
+
+[NCSOFT](https://nc.com)
+

dustrack-1.0.0/README.md

@@ -0,0 +1,111 @@
+# DUSTrack
+
+[![src](https://img.shields.io/badge/src-github-blue)](https://github.com/praneethnamburi/DUSTrack)
+[![PyPI - Version](https://img.shields.io/pypi/v/DUSTrack.svg?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/DUSTrack/)
+[![Documentation Status](https://readthedocs.org/projects/DUSTrack/badge/?version=latest)](https://DUSTrack.readthedocs.io)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/praneethnamburi/DUSTrack/main/LICENSE)
+
+*Semi-automated point tracking in videos. Designed for ultrasound videos, but works with natural videos as well.*
+
+`DUSTrack` (Deep learning and optical flow-based toolkit for UltraSound Tracking) is a semi-automated framework for tracking arbitrary points in B-mode ultrasound videos. It combines deep learning with optical flow to deliver high-quality, robust tracking across diverse anatomical structures and motion patterns. The toolkit includes a graphical user interface that streamlines the generation of high-quality training data and supports iterative model refinement. It also implements a novel optical-flow-based filtering technique that reduces high-frequency frame-to-frame noise while preserving rapid tissue motion.
+
+## Features
+
+- **Hybrid approach**: Combines deep learning with optical flow for accurate tracking
+- **User-friendly GUI**: Streamlines training data generation and model refinement
+- **Noise reduction**: Novel optical-flow-based filtering preserves rapid motion while reducing frame-to-frame noise
+- **Versatile**: Works with ultrasound and other video types
+- **Flexible installation**: Use GUI + optical flow only, or add deep learning capabilities
+
+Learn more about DUSTrack in our [paper in *Scientific Reports*](https://doi.org/10.1038/s41598-026-42795-3).
+
+## Installation
+
+### Option 1: GUI + Optical Flow Only (Recommended for Short Videos)
+
+For tracking points in videos with a few hundred frames, this lightweight installation is sufficient:
+
+```sh
+pip install DUSTrack
+```
+
+**Troubleshooting dependencies**: If you encounter dependency issues, use conda with the provided `requirements.yml` file:
+
+```sh
+conda env create -n env-dustrack -f https://github.com/praneethnamburi/DUSTrack/raw/main/requirements.yml
+conda activate env-dustrack
+pip install DUSTrack
+```
+
+### Option 2: Full Installation (Including Deep Learning)
+
+For longer videos or ultrasound videos with repetitive motions, deep learning significantly reduces manual effort and improves tracking quality:
+
+1. Create a conda environment and install DeepLabCut by following [these instructions](https://deeplabcut.github.io/DeepLabCut/docs/installation.html)
+2. Activate your DeepLabCut environment and install DUSTrack:
+   ```sh
+   conda activate <your-dlc-env>
+   pip install DUSTrack
+   ```
+
+## Quick Start
+
+```python
+from dustrack import DUSTrack
+import datanavigator
+
+# Launch the GUI with an example video
+video_path = datanavigator.get_example_video()  # or use your own video path
+d = DUSTrack(video_path, "pn") 
+# The second argument is the name of the "layer" for storing tracking annotations
+```
+
+**Next steps:**
+- Use the GUI to mark points of interest in your video (see [Keyboard shortcuts](https://github.com/praneethnamburi/DUSTrack/raw/main/docs/source/resources/keyboard_shortcuts.png))
+- Track points using optical flow and/or train a deep learning model
+- Export tracking results as a `.json` file for further analysis
+
+For detailed tutorials and examples, see the [documentation](https://DUSTrack.readthedocs.io).
+
+## Documentation
+
+Full documentation is available at [DUSTrack.readthedocs.io](https://DUSTrack.readthedocs.io).
+
+## Citation
+
+If you use DUSTrack in your research, please cite our paper:
+
+```bibtex
+@article{namburi2026dustrack,
+  title={DUSTrack: Semi-automated point tracking in ultrasound videos},
+  author={Namburi, Praneeth and Pallar{\`e}s-L{\'o}pez, Roger and Rosendorf, Jessica and Folgado, Duarte and Anthony, Brian W},
+  journal={Scientific Reports},
+  volume={16},
+  pages={13340},
+  year={2026},
+  doi={10.1038/s41598-026-42795-3}
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to:
+- Submit a Pull Request with improvements or bug fixes
+- Share your use cases and feedback ([contact](https://praneethnamburi.com/contact/))
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+[Praneeth Namburi](https://praneethnamburi.com)
+
+Project Link: [https://github.com/praneethnamburi/DUSTrack](https://github.com/praneethnamburi/DUSTrack)
+
+
+## Acknowledgments
+
+[MIT.nano Immersion Lab](https://immersion.mit.edu)
+
+[NCSOFT](https://nc.com)

dustrack-1.0.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)