Metadata-Version: 2.4
Name: vars-localize
Version: 0.4.0
Summary: Tool for creating localization with VARS.
Author-email: Kevin Barnard <kbarnard@mbari.org>
Keywords: VARS,annotation,localization
Requires-Python: >=3.10
Requires-Dist: loguru>=0.7.2
Requires-Dist: pyqt6>=6.7.1
Requires-Dist: qdarkstyle>=3.2.3
Requires-Dist: requests>=2.32.3
Provides-Extra: sam
Requires-Dist: timm; extra == 'sam'
Requires-Dist: ultralytics>=8.4.26; extra == 'sam'
Description-Content-Type: text/markdown

# vars-localize
Tool for creating localizations within the VARS database.

Author: Kevin Barnard ([kbarnard@mbari.org](mailto:kbarnard@mbari.org))

## :hammer: Installation

> [!NOTE]
> VARS Localize requires Python 3.10 or later.

To install VARS Localize, run:
```bash
pip install vars-localize
```

To install with local SAM3 assist support, run:
```bash
pip install "vars-localize[sam]"
```

Note that SAM3 support requires additional model setup; see the [SAM3 Assist](https://docs.mbari.org/vars-localize/user-guide/sam3/sam3-assist/) documentation for details.

## :rocket: Basic Usage

To start the application, run:
```bash
vars-localize
```

On Linux, you can also install a user desktop launcher and icons:
```bash
vars-localize install-desktop
```

Once the application launches, enter your M3 URL, then log in with your VARS username and password.

For complete setup, workflows, UI guidance, and SAM3 details, see:

- https://docs.mbari.org/vars-localize

## Credits

VARS Localize is made with [PyQt6](https://pypi.org/project/PyQt6/).

---

Copyright &copy; 2019 [Monterey Bay Aquarium Research Institute](https://www.mbari.org/)