Skip to main content

An extension of yt for working with merger-tree data.

Project description

ytree

Build Status Coverage Status Documentation Status PyPI version DOI

This is ytree, a yt extension for generating and working with merger-tree data. ytree supports:

  • loading merger-tree data from the Amiga Halo Finder, Consistent-Trees, Rockstar, and LHaloTree formats

  • creating merger trees from Gadget's inline FOF/SUBFIND catalogs

  • fast, on-demand loading of trees and fields

  • symbolic units, derived fields, and alias fields

  • saving trees to a universal format

Installation

ytree can be installed with pip:

pip install ytree

To get the development version, clone this repository and install like this:

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

Getting Started

Below is a notebook that demonstrates how to use ytree with merger-tree data. For more information, see the full ytree documenation.

Sample Data

Sampled data for all merger-tree formats supported by ytree is available on the yt Hub in the ytree data collection.

Contributing

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

Citing ytree

If you use ytree in your work, please cite the following:

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://ytree.readthedocs.io.

Resources

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ytree-2.2.1.tar.gz (74.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ytree-2.2.1-py2.py3-none-any.whl (78.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ytree-2.2.1.tar.gz.

File metadata

  • Download URL: ytree-2.2.1.tar.gz
  • Upload date:
  • Size: 74.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for ytree-2.2.1.tar.gz
Algorithm Hash digest
SHA256 9868bb0743a0fe8fd81acb4857ed9f7f4c79ae56178d69bb37d7926d8092c252
MD5 81ef6861870cddc74c8a98aae66c3ffc
BLAKE2b-256 ac31001334b77c8586d6741f7b7c1c11c980de9263af114d8358f34cbd7daf1e

See more details on using hashes here.

File details

Details for the file ytree-2.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: ytree-2.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 78.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.0 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.3

File hashes

Hashes for ytree-2.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a15c20639bfb31cc3732da1806d15900dd086fef98b26fc4feca07581f426a3b
MD5 df8dabebd315c1a292d1f81f58e7ae20
BLAKE2b-256 54c0a4de35912f90f3aa9497ac511bbdf7f97778a6a01e6910005936011d9164

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page