Skip to content

Commit

Permalink
Fix PyPI README: emojis & logo (#293)
Browse files Browse the repository at this point in the history
* Emojis are unicode

* Fix markdown links

* Fix docs links

* Revert "Fix docs links"

This reverts commit 0e4029d.

* Revert "Fix markdown links"

This reverts commit 7b74400.

* Retrieve logo from docs

* Fix links
  • Loading branch information
paddyroddy authored Apr 4, 2023
1 parent cfa8e18 commit f28381f
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,9 @@
[![Documentation](https://readthedocs.org/projects/btrack/badge/?version=latest)](https://btrack.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/quantumjot/btrack/branch/main/graph/badge.svg?token=QCFC9AWK0R)](https://codecov.io/gh/quantumjot/btrack)

[docs]: https://btrack.readthedocs.io/en/latest/
[docs-dev]: https://btrack.readthedocs.io/en/latest/dev_guide/
[cellx]: http://lowe.cs.ucl.ac.uk/cellx.html
![logo](https://btrack.readthedocs.io/en/latest/_images/btrack_logo.png)

![logo](./docs/_static/btrack_logo.png)

# Bayesian Tracker (btrack) :microscope::computer:
# Bayesian Tracker (btrack) 🔬💻

`btrack` is a Python library for multi object tracking, used to reconstruct trajectories in crowded fields.
Here, we use a probabilistic network of information to perform the trajectory linking.
Expand All @@ -28,10 +24,6 @@ The global solution identifies a sequence of high-likelihood hypotheses that acc

We developed `btrack` for cell tracking in time-lapse microscopy data.

[Read more about the science][cellx].

You can also --> :star: :wink:

## Installation

`btrack` has been tested with Python 3.8+ on OS X, Linux and Win10.
Expand All @@ -55,7 +47,7 @@ pip install btrack

## Usage examples

Visit [btrack documentation][docs] to learn how to use it and see other examples.
Visit [btrack documentation](https://btrack.readthedocs.io) to learn how to use it and see other examples.

### Cell tracking in time-lapse imaging data

Expand All @@ -74,7 +66,7 @@ Visit [btrack documentation][docs] to learn how to use it and see other examples
## Development

The tracker and hypothesis engine are mostly written in C++ with a Python wrapper.
If you would like to contribute to btrack, you will need to install the latest version from GitHub. Follow the [instructions on our developer guide][docs-dev].
If you would like to contribute to btrack, you will need to install the latest version from GitHub. Follow the [instructions on our developer guide](https://btrack.readthedocs.io/en/latest/dev_guide).


---
Expand Down

0 comments on commit f28381f

Please sign in to comment.