treefarm

This is treefarm, a yt extension for creating merger-trees. The treefarm package was originally a part of ytree, but is now its own thing.

Installation

Currently, treefarm can only be installed from source. To get the development version, clone this repository and install like this:

git clone https://github.com/ytree-project/treefarm
cd treefarm
pip install -e .

Sample Data

Sampled data for making some small merger-trees is available on the yt Hub in the ytree data collection.

Contributing

treefarm would be much better with your contribution! As an extension of the yt Project, we follow the yt guidelines for contributing.

Citing treefarm

If you use treefarm in your work, please cite the ytree package for now:

Britton Smith, & Meagan Lang. (2018, February 16). ytree: merger-tree toolkit. Zenodo.
https://doi.org/10.5281/zenodo.1174374

For BibTeX users:

  @misc{britton_smith_2018_1174374,
    author       = {Britton Smith and
                    Meagan Lang},
    title        = {ytree: merger-tree toolkit},
    month        = feb,
    year         = 2018,
    doi          = {10.5281/zenodo.1174374},
    url          = {https://doi.org/10.5281/zenodo.1174374}
  }

If possible, please also add a footnote pointing to https://treefarm.readthedocs.io.

Resources

• The latest documentation can be found at https://treefarm.readthedocs.io

• treefarm is an extension of the yt Project. The yt-project community resources can be used for treefarm-related communication.