ytree
  • Help
  • Citing ytree
  • Installation
    • Installing Stable Releases
      • pip
      • conda
    • Installing from Source
    • Installing yt
  • What version do I have?
  • Sample Data
  • An Important Note on Comoving and Proper Units
  • Working with Merger Trees
    • Example Applications
    • Loading Data
      • Loading Data
        • Amiga Halo Finder
        • Consistent-Trees
        • Consistent-Trees-HDF5
        • Gadget4
        • Generic CSV Data
        • LHaloTree
        • LHaloTree-HDF5
        • MORIA
        • Rockstar Catalogs
        • TreeFarm
        • TreeFrog
        • Saved Arbors (ytree format)
    • Getting Started with Merger Trees
      • Useful Arbor Attributes
        • Creating Arrays and Quantities with Units
        • Cosmology Calculations
      • How many trees are there?
      • Root Fields
      • Accessing Individual Trees
      • Accessing the Nodes in a Tree or Forest
      • Accessing All Nodes in a Tree
      • Accessing All Nodes in a Forest
      • Frontends that Support Forests
      • Accessing a Halo’s Ancestors and Descendent
      • Accessing the Progenitor Lineage of a Tree
      • Customizing the Progenitor Line
      • Accessing a Single Node in a Tree
      • Accessing the Leaf Nodes of a Tree
      • Accessing the Root Nodes of a Forest
    • Saving Arbors and Trees
      • Saving New Fields In Place
    • Arbitrary Collections of TreeNodes
    • Searching Through Merger Trees (Accessing Like a Database)
      • Select Halos
      • Select Halos with yt
      • Creating the Selection
      • Querying the Selection
      • Getting Halos from the Selection
    • Halos and Fields from yt Data Containers
  • Fields in ytree
    • The Field Info Container
    • Fields on Disk
    • Alias Fields
    • Derived Fields
    • Vector Fields
    • Analysis Fields
      • Re-saving Analysis Fields and Updating Existing Arbors
      • Updating only the Root Nodes
  • Plotting Merger Trees
    • Additional Dependencies
    • Making Tree Plots
      • Plot Modifications
      • Customizing Node Appearance
      • Customizing Edge Appearance
      • Supported Output Formats
  • Parallel Computing with ytree
    • Enabling Parallelism and Running in Parallel
    • An Important Note on Parallel Performance
    • Parallel Iterators
      • Parallelizing over Trees
      • Parallelizing over Nodes in a Single Tree
      • Parallelizing over Nodes in a List of Trees
  • Analyzing Merger Trees
    • The AnalysisPipeline
      • Creating an AnalysisPipeline
      • Creating Pipeline Operations
      • Adding Extra Function Arguments
      • Organizing File Output by Operation
      • Using a Function as a Filter
      • Adding Operations that Always Run
      • Adding Functions that Only Run Once
      • Modifying a Node
      • Running the Pipeline
      • Passing Attributes Between Nodes
      • Creating a Analysis Recipe
      • Reloading Arbors to Reduce Memory Usage
    • Putting it all Together: Parallel Analysis
  • Example Applications
    • Plot the Tree of the Most Massive Halo
    • Plot the Tree with the Most Halos
    • Halo Age (a50)
    • Significance
  • API Reference
    • Working with Merger Trees
      • ytree.data_structures.load.load
        • load
      • ytree.data_structures.arbor.Arbor
        • Arbor
      • ytree.data_structures.arbor.Arbor.add_alias_field
        • Arbor.add_alias_field
      • ytree.data_structures.arbor.Arbor.add_analysis_field
        • Arbor.add_analysis_field
      • ytree.data_structures.arbor.Arbor.add_derived_field
        • Arbor.add_derived_field
      • ytree.data_structures.arbor.Arbor.add_vector_field
        • Arbor.add_vector_field
      • ytree.data_structures.arbor.Arbor.arr
        • Arbor.arr
      • ytree.data_structures.arbor.Arbor.container
        • Arbor.container
      • ytree.data_structures.arbor.Arbor.cosmology
        • Arbor.cosmology
      • ytree.data_structures.arbor.Arbor.quan
        • Arbor.quan
      • ytree.data_structures.arbor.Arbor.save_arbor
        • Arbor.save_arbor
      • ytree.data_structures.arbor.Arbor.select_halos
        • Arbor.select_halos
      • ytree.data_structures.arbor.Arbor.set_selector
        • Arbor.set_selector
      • ytree.data_structures.node_container.NodeContainer
        • NodeContainer
      • ytree.data_structures.tree_node.TreeNode
        • TreeNode
      • ytree.data_structures.tree_node.TreeNode.get_leaf_nodes
        • TreeNode.get_leaf_nodes
      • ytree.data_structures.tree_node.TreeNode.get_root_nodes
        • TreeNode.get_root_nodes
      • ytree.data_structures.tree_node.TreeNode.get_node
        • TreeNode.get_node
      • ytree.data_structures.tree_node.TreeNode.save_tree
        • TreeNode.save_tree
      • ytree.data_structures.tree_node_selector.TreeNodeSelector
        • TreeNodeSelector
      • ytree.data_structures.tree_node_selector.TreeNodeSelector
        • TreeNodeSelector
      • ytree.data_structures.tree_node_selector.add_tree_node_selector
        • add_tree_node_selector
      • ytree.data_structures.tree_node_selector.max_field_value
        • max_field_value
      • ytree.data_structures.tree_node_selector.min_field_value
        • min_field_value
      • ytree.frontends.ytree.arbor.YTreeArbor.get_yt_selection
        • YTreeArbor.get_yt_selection
      • ytree.frontends.ytree.arbor.YTreeArbor.get_nodes_from_selection
        • YTreeArbor.get_nodes_from_selection
      • ytree.frontends.ytree.arbor.YTreeArbor.reload_arbor
        • YTreeArbor.reload_arbor
      • ytree.frontends.ytree.arbor.YTreeArbor.ytds
        • YTreeArbor.ytds
    • Visualizing Merger Trees
      • ytree.visualization.tree_plot.TreePlot
        • TreePlot
      • ytree.visualization.tree_plot.TreePlot.save
        • TreePlot.save
    • Analysis Pipeline
      • ytree.analysis.analysis_pipeline.AnalysisPipeline
        • AnalysisPipeline
      • ytree.analysis.analysis_pipeline.AnalysisPipeline.add_operation
        • AnalysisPipeline.add_operation
      • ytree.analysis.analysis_pipeline.AnalysisPipeline.add_recipe
        • AnalysisPipeline.add_recipe
      • ytree.analysis.analysis_pipeline.AnalysisPipeline.process_target
        • AnalysisPipeline.process_target
      • ytree.analysis.analysis_operators.AnalysisOperation
        • AnalysisOperation
    • Parallelism
      • ytree.utilities.parallel.parallel_trees
        • parallel_trees
      • ytree.utilities.parallel.parallel_tree_nodes
        • parallel_tree_nodes
      • ytree.utilities.parallel.parallel_nodes
        • parallel_nodes
    • Internal Classes
      • Base Classes
        • ytree.data_structures.arbor.Arbor
        • ytree.data_structures.arbor.SegmentedArbor
        • ytree.data_structures.arbor.CatalogArbor
        • ytree.data_structures.detection.Detector
        • ytree.data_structures.detection.FieldDetector
        • ytree.data_structures.detection.SelectionDetector
        • ytree.data_structures.fields.FieldInfoContainer
        • ytree.data_structures.fields.FieldContainer
        • ytree.data_structures.io.FieldIO
        • ytree.data_structures.io.TreeFieldIO
        • ytree.data_structures.io.DefaultRootFieldIO
        • ytree.data_structures.io.DataFile
        • ytree.data_structures.io.CatalogDataFile
      • Arbor Subclasses
        • ytree.frontends.ahf.arbor.AHFArbor
        • ytree.frontends.consistent_trees.arbor.ConsistentTreesArbor
        • ytree.frontends.consistent_trees.arbor.ConsistentTreesGroupArbor
        • ytree.frontends.consistent_trees.arbor.ConsistentTreesHlistArbor
        • ytree.frontends.consistent_trees_hdf5.arbor.ConsistentTreesHDF5Arbor
        • ytree.frontends.csv.arbor.CSVArbor
        • ytree.frontends.gadget4.arbor.Gadget4Arbor
        • ytree.frontends.lhalotree.arbor.LHaloTreeArbor
        • ytree.frontends.lhalotree_hdf5.arbor.LHaloTreeHDF5Arbor
        • ytree.frontends.moria.arbor.MoriaArbor
        • ytree.frontends.rockstar.arbor.RockstarArbor
        • ytree.frontends.treefarm.arbor.TreeFarmArbor
        • ytree.frontends.ytree.arbor.YTreeArbor
      • FieldInfo Subclasses
        • ytree.frontends.ahf.fields.AHFFieldInfo
        • ytree.frontends.consistent_trees.fields.ConsistentTreesFieldInfo
        • ytree.frontends.consistent_trees_hdf5.fields.ConsistentTreesHDF5FieldInfo
        • ytree.frontends.gadget4.fields.Gadget4FieldInfo
        • ytree.frontends.lhalotree.fields.LHaloTreeFieldInfo
        • ytree.frontends.lhalotree_hdf5.fields.LHaloTreeHDF5FieldInfo
        • ytree.frontends.moria.fields.MoriaFieldInfo
        • ytree.frontends.rockstar.fields.RockstarFieldInfo
        • ytree.frontends.treefarm.fields.TreeFarmFieldInfo
      • FieldIO Subclasses
        • ytree.frontends.consistent_trees.io.ConsistentTreesTreeFieldIO
        • ytree.frontends.consistent_trees_hdf5.io.ConsistentTreesHDF5TreeFieldIO
        • ytree.frontends.consistent_trees_hdf5.io.ConsistentTreesHDF5RootFieldIO
        • ytree.frontends.gadget4.io.Gadget4TreeFieldIO
        • ytree.frontends.lhalotree.io.LHaloTreeTreeFieldIO
        • ytree.frontends.lhalotree.io.LHaloTreeRootFieldIO
        • ytree.frontends.lhalotree_hdf5.io.LHaloTreeHDF5TreeFieldIO
        • ytree.frontends.moria.io.MoriaTreeFieldIO
        • ytree.frontends.ytree.io.YTreeTreeFieldIO
        • ytree.frontends.ytree.io.YTreeRootFieldIO
      • DataFile Subclasses
        • ytree.frontends.ahf.io.AHFDataFile
        • ytree.frontends.consistent_trees.io.ConsistentTreesDataFile
        • ytree.frontends.consistent_trees.io.ConsistentTreesHlistDataFile
        • ytree.frontends.consistent_trees_hdf5.io.ConsistentTreesHDF5DataFile
        • ytree.frontends.csv.io.CSVDataFile
        • ytree.frontends.gadget4.io.Gadget4DataFile
        • ytree.frontends.lhalotree_hdf5.io.LHaloTreeHDF5DataFile
        • ytree.frontends.moria.io.MoriaDataFile
        • ytree.frontends.rockstar.io.RockstarDataFile
        • ytree.frontends.treefarm.io.TreeFarmDataFile
        • ytree.frontends.ytree.io.YTreeDataFile
  • Community Code of Conduct
  • Contributing to ytree
  • Developer Guide
    • Contributing in a Nutshell
    • Testing
      • Testing Data
      • Installing Development Dependencies
      • Run the Tests
    • Adding Support for a New Format
      • Where do the files go?
      • Building Your Frontend
      • The _is_valid Function
      • Two Types of Arbors
        • Merger Tree Data in One File (or a few)
        • Halo Catalog-style Data
      • Field Units and Aliases (fields.py)
      • You made it!
      • Everyone Loves Samples
  • ChangeLog
    • Contributors
    • Version 3.3.0
      • New Features
      • Minor Enhancements
      • Bugfixes
      • Infrastructure Updates
    • Version 3.2.1
      • Bugfixes
    • Version 3.2.0
      • New Features
      • Minor Enhancements
      • Bugfixes
      • Infrastructure Updates
    • Version 3.1.2
      • Minor Enhancements
      • Bugfixes
      • Infrastructure Updates
    • Version 3.1.1
      • Bugfixes
      • Infrastructure Updates
    • Version 3.1
      • New Featues
    • Version 3.0
      • New Featues
      • Enhancements
      • Bugfixes
    • Version 2.3
      • New Features
      • Enhancements
    • Version 2.2.1
      • Enhancements
      • Bugfixes
    • Version 2.2
      • New Features
      • Enhancements
    • Version 2.1.1
      • Bugfixes
    • Version 2.1
      • New Features
    • Version 2.0.2
      • Enhancements
    • Version 2.0
      • New Features
      • Enhancements
    • Version 1.1
      • New Features
      • Enhancements
      • Bugfixes
    • Version 1.0
ytree
  • Overview: module code

All modules for which code is available

  • ytree.analysis.analysis_operators
  • ytree.analysis.analysis_pipeline
  • ytree.data_structures.arbor
  • ytree.data_structures.detection
  • ytree.data_structures.fields
  • ytree.data_structures.io
  • ytree.data_structures.load
  • ytree.data_structures.node_container
  • ytree.data_structures.tree_node
  • ytree.data_structures.tree_node_selector
  • ytree.frontends.ahf.arbor
  • ytree.frontends.ahf.fields
  • ytree.frontends.ahf.io
  • ytree.frontends.consistent_trees.arbor
  • ytree.frontends.consistent_trees.fields
  • ytree.frontends.consistent_trees.io
  • ytree.frontends.consistent_trees_hdf5.arbor
  • ytree.frontends.consistent_trees_hdf5.fields
  • ytree.frontends.consistent_trees_hdf5.io
  • ytree.frontends.csv.arbor
  • ytree.frontends.csv.io
  • ytree.frontends.gadget4.arbor
  • ytree.frontends.gadget4.fields
  • ytree.frontends.gadget4.io
  • ytree.frontends.lhalotree.arbor
  • ytree.frontends.lhalotree.fields
  • ytree.frontends.lhalotree.io
  • ytree.frontends.lhalotree_hdf5.arbor
  • ytree.frontends.lhalotree_hdf5.fields
  • ytree.frontends.lhalotree_hdf5.io
  • ytree.frontends.moria.arbor
  • ytree.frontends.moria.fields
  • ytree.frontends.moria.io
  • ytree.frontends.rockstar.arbor
  • ytree.frontends.rockstar.fields
  • ytree.frontends.rockstar.io
  • ytree.frontends.treefarm.arbor
  • ytree.frontends.treefarm.fields
  • ytree.frontends.treefarm.io
  • ytree.frontends.ytree.arbor
  • ytree.frontends.ytree.io
  • ytree.utilities.parallel
  • ytree.visualization.tree_plot

© Copyright ytree development team. All rights reserved..

Built with Sphinx using a theme provided by Read the Docs.