Skip to content

Simplify PyPI install docs and include demo deps - #1

Merged
lexiyutou merged 5 commits into
mainfrom
docs/demo-installation-readme
Apr 16, 2026
Merged

Simplify PyPI install docs and include demo deps#1
lexiyutou merged 5 commits into
mainfrom
docs/demo-installation-readme

Conversation

@MMathisLab

Copy link
Copy Markdown
Member

Summary

  • Simplify installation docs to a concise PyPI-first flow in README.md.
  • Remove test.pypi.org references and use a straightforward pip install prima-animal command.
  • Include demo runtime dependencies in main package metadata (pyproject.toml) by adding Detectron2 and DeepLabCut.
  • Clarify demo command examples and output locations for demo.py, demo_tta.py, and app.py.

Document local editable installation, clarify demo-specific optional dependencies, and expand demo commands/output notes so users can run no-TTA, TTA, and Gradio demos with the required packages.

Made-with: Cursor
…. Streamlined local setup details, emphasized PyPI installation, and consolidated optional dependencies for better user guidance.
Add Detectron2 and DeepLabCut to core dependencies so the default PRIMA installation includes packages required for demo execution.

Made-with: Cursor
Use an unpinned `pip install prima-animal` instruction so users install the latest published release by default.

Made-with: Cursor
@MMathisLab
MMathisLab requested a review from lexiyutou April 16, 2026 14:51
@MMathisLab MMathisLab added the documentation Improvements or additions to documentation label Apr 16, 2026
@lexiyutou

Copy link
Copy Markdown
Collaborator

Thanks @MMathisLab
One question, the PyPI package of prima-animal is still under construction now, right?

@MMathisLab

Copy link
Copy Markdown
Member Author

after merge, I will release it on pypi @lexiyutou

@lexiyutou
lexiyutou merged commit 58642d9 into main Apr 16, 2026
4 checks passed
@MMathisLab
MMathisLab deleted the docs/demo-installation-readme branch April 16, 2026 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants