Metadata-Version: 2.1
Name: motile
Version: 0.1.2
Summary: Multi-Object Tracker using Integer Linear Equations
Project-URL: homepage, https://github.com/funkelab/motile
Author-email: Jan Funke <funkej@janelia.hhmi.org>, Talley Lambert <talley.lambert@gmail.com>
License: MIT
License-File: LICENSE
Requires-Dist: ilpy
Requires-Dist: networkx
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: flake8; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# motile: Multi-Object Tracker using Integer Linear Equations

`motile` tracks multiple objects by solving a global optimization problem.

Read all about it in the [documentation](https://funkelab.github.io/motile/).

## Installation

Motile depends on `ilpy`, which is currently only available via
conda on the `funkelab` channel.  `ilpy` in turn requires
gurobi which is only available via the `gurobi` channel.

So, to create a new environment with motile:

```bash
conda create -n my_env -c conda-forge -c funkelab -c gurobi ilpy
conda activate my_env
pip install motile
```

or, to install into an existing environment:

```bash
conda install -c conda-forge -c funkelab -c gurobi ilpy
pip install motile
```

## Development

```sh
git clone https://github.com/funkelab/motile  # or your fork
cd motile

# currently required to build ilpy dependency wheel
conda install scip

pip install -e .[dev]
```

### Testing

```sh
pytest
```

### Deployment

> note for developers

To deploy a new version, first make sure to bump the version string in
`motile/__init__.py`.  Then create an **annotated** tag, and push it to github.
This will trigger the `deploy.yaml` workflow to upload to PyPI

```bash
git tag -a vX.Y.Z -m vX.Y.Z
git push upstream --follow-tags
```
