mistree 2.0.0
A python package for constructing and analysing the minimum spanning tree
License: MIT
Requires Python: >=3.7

# MiSTree


[![MiSTree Version](https://img.shields.io/badge/Version-2.0.0-green)](https://img.shields.io/badge/Version-2.0.0-green) [![PyPI version](https://badge.fury.io/py/mistree.svg)](https://badge.fury.io/py/mistree) [![Python Version Support](https://img.shields.io/badge/Python-3.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11-blue)](https://img.shields.io/badge/Python-3.7%20|%203.8%20|%203.9-blue) [![Ubuntu](https://github.com/knaidoo29/mistree/actions/workflows/python-package.yml/badge.svg?branch=pure_python)](https://github.com/knaidoo29/mistree/actions/workflows/python-package.yml) [![MacOS](https://github.com/knaidoo29/mistree/actions/workflows/python-package_macos.yml/badge.svg?branch=pure_python)](https://github.com/knaidoo29/mistree/actions/workflows/python-package_macos.yml) [![Windows](https://github.com/knaidoo29/mistree/actions/workflows/python-package_windows.yml/badge.svg?branch=pure_python)](https://github.com/knaidoo29/mistree/actions/workflows/python-package_windows.yml) [![coverage](https://raw.githubusercontent.com/knaidoo29/mistree/refs/heads/pure_python/coverage.svg)](https://raw.githubusercontent.com/knaidoo29/mistree/refs/heads/pure_python/coverage.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![status](https://joss.theoj.org/papers/461d79e9e5faf21029c0a7b1c928be28/status.svg)](https://joss.theoj.org/papers/461d79e9e5faf21029c0a7b1c928be28) [![ascl](https://img.shields.io/badge/ascl-1910.016-blue.svg?colorB=262255)](http://ascl.net/1910.016) [![DOI](https://zenodo.org/badge/170473458.svg)](https://zenodo.org/badge/latestdoi/170473458) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/knaidoo29/mistree/master?filepath=tutorials%2Fnotebooks%2F)

## Introduction

The *minimum spanning tree* (MST), a graph constructed from a distribution of points, draws lines between pairs of points so that all points are linked in a single skeletal structure that contains no loops and has minimal total edge length. The MST has been used in a broad range of scientific fields such as particle physics, in astronomy and cosmology. Its success in these fields has been driven by its sensitivity to the spatial distribution of points and the patterns within. ``MiSTree``, a public ``Python`` package, allows a user to construct the MST in a variety of coordinates systems, including Celestial coordinates used in astronomy. The package enables the MST to be constructed quickly by initially using a *k*-nearest neighbour graph (*k* NN, rather than a matrix of pairwise distances) which is then fed to Kruskal's algorithm to construct the MST. ``MiSTree`` enables a user to measure the statistics of the MST and provides classes for binning the MST statistics (into histograms) and plotting the distributions. Applying the MST will enable the inclusion of high-order statistics information from the cosmic web which can provide additional information to improve cosmological parameter constraints. This information has not been fully exploited due to the computational cost of calculating *N*-point statistics. ``MiSTree`` was designed to be used in cosmology but could be used in any field which requires extracting non-Gaussian information from point distributions.

## Dependencies

* `numpy`
* `numba`
* `matplotlib`
* `scipy`
* `scikit-learn`

For testing you will require `nose` or `pytest`.

## Installation

MiSTree can be installed as follows:

```
pip install mistree [--user]
```
The `--user` is optional and only required if you don’t have write permission. If you
are using a windows machine this may not work, in this case (or as an alternative to pip) clone the repository,

```
git clone https://github.com/knaidoo29/mistree.git
cd mistree
```

and install by either running

```
pip install . [--user]
```

or

```
python setup.py build
python setup.py install
```

Similarly, if you would like to work and edit mistree you can clone the repository and install an editable version:

```
git clone https://github.com/knaidoo29/mistree.git
cd mistree
pip install -e . [--user]
```

From the `mistree` directory you can then test the install using `nose`:

```
python setup.py test
```

or using `pytest`:

```
python -m pytest
```

You should now be able to import the module:

```python
import mistree as mist
```

## Documentation

In depth documentation and tutorials are provided [here](https://knaidoo29.github.io/mistreedoc/).

## Tutorials

The tutorials in the documentation are supplied as ipython notebooks which can be downloaded from [here](https://github.com/knaidoo29/mistree/tree/master/tutorials/notebooks) or can be run online using [binder](https://mybinder.org/v2/gh/knaidoo29/mistree/master?filepath=tutorials%2Fnotebooks%2F).

## Citing

You can cite ``MiSTree`` using the following BibTex:

```
@ARTICLE{Naidoo2019,
       author = {{Naidoo}, Krishna},
        title = "{MiSTree: a Python package for constructing and analysing Minimum Spanning Trees}",
      journal = {The Journal of Open Source Software},
         year = "2019",
        month = "Oct",
       volume = {4},
       number = {42},
          eid = {1721},
        pages = {1721},
          doi = {10.21105/joss.01721},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2019JOSS....4.1721N}
}
```

## Support

If you have any issues with the code or want to suggest ways to improve it please open a new issue ([here](https://github.com/knaidoo29/mistree/issues))
or (if you don't have a github account) email _krishna.naidoo.11@ucl.ac.uk_.