linefinder.linefinder module

This module contains functions for easily running all aspects of linefinder.

linefinder.linefinder.run_linefinder(tag, out_dir=None, sim_data_dir=None, halo_data_dir=None, main_mt_halo_id=None, sim_name=None, galdef=None, selector_data_filters={}, selector_kwargs={}, sampler_kwargs={}, tracker_kwargs={}, gal_linker_kwargs={}, classifier_kwargs={}, run_id_selecting=True, run_id_sampling=True, run_tracking=True, run_galaxy_linking=True, run_classifying=True)[source]

Main function for running linefinder. Not as feature complete as the Jug-enabled version.

Parameters:
  • tag (str) – Filename identifier for data products.
  • out_dir (str) – Output directory to store the data in.
  • galdef (str) – Which set of parameters to use for the galaxy_linking and classification steps?
  • sim_name (str) – Name of simulation to run linefinder for. If provided, linefinder will automatically fill in many arguments using a file_manager and the linefinder.config file.
  • selector_data_filters (dict) – Data filters to pass to select.IDSelector.select_ids()
  • selector_kwargs (dict) – Arguments to use when selecting what particles to track. Arguments will be passed to select.IDSelector
  • sampler_kwargs (dict) – Arguments to use when selecting what particles to track. Arguments will be passed to select.IDSampler
  • tracker_kwargs (dict) – Arguments to use when tracking particles. Arguments will be passedts to pass to track.ParticleTracker
  • gal_linker_kwargs (dict) – Arguments to use when associating particles with galaxies. Arguments will be passed to galaxy_link.ParticleTrackGalaxyLinker
  • classifier_kwargs (dict) – Arguments to use when classifying particles. Arguments will be passed to classify.Classifier
  • run_id_selecting (bool) – If True, then run routines for selecting particles.
  • run_id_sampling (bool) – If True, then run routines for sampling from the full list of selected particles.
  • run_tracking (bool) – If True, then run routines for tracking particles.
  • run_galaxy_linking (bool) – If True, then run routines for associating particles with galaxies.
  • run_classifying (bool) – If True, then run routines for classifying particles.
linefinder.linefinder.run_linefinder_jug(tag, out_dir=None, sim_data_dir=None, halo_data_dir=None, main_mt_halo_id=None, sim_name=None, galdef=None, selector_data_filters={}, selector_kwargs={}, sampler_kwargs={}, tracker_kwargs={}, gal_linker_kwargs={}, classifier_kwargs={}, visualization_kwargs={}, run_id_selecting=True, run_id_sampling=True, run_tracking=True, run_galaxy_linking=True, run_classifying=True, run_visualization=True)[source]

Main function for running linefinder.

Parameters:
  • tag (str) – Filename identifier for data products.
  • out_dir (str) – Output directory to store the data in.
  • sim_data_dir (str) – Directory the simulation data is stored in.
  • halo_data_dir (str) – Directory the halo data (e.g. AHF output) is stored in. Halo data is necessary for linking particles to galaxies.
  • main_mt_halo_id (int) – Halo ID for the main merger tree halo that’s being tracked. If not provided defaults to 0 (or whatever value is cataloged for the sim name).
  • sim_name (str) – Name of the simulation this is being run for. If provided then linefinder will automatically choose the location of the simulation and halo data, according to the linefinder.config file. The sim_data_dir or halo_data_dir arguments directly overwrites this.
  • galdef (str) – Which set of parameters to use for the galaxy_linking and classification steps? Defaults to the parameters in linefinder.config
  • selector_data_filters (dict) – Data filters to pass to select.IDSelector.select_ids()
  • selector_kwargs (dict) – Arguments to use when selecting what particles to track. Arguments will be passed to select.IDSelector
  • sampler_kwargs (dict) – Arguments to use when selecting what particles to track. Arguments will be passed to select.IDSampler
  • tracker_kwargs (dict) – Arguments to use when tracking particles. Arguments will be passedts to pass to track.ParticleTracker
  • gal_linker_kwargs (dict) – Arguments to use when associating particles with galaxies. Arguments will be passed to galaxy_link.ParticleTrackGalaxyLinker
  • classifier_kwargs (dict) – Arguments to use when classifying particles. Arguments will be passed to classify.Classifier
  • visualization_kwargs (dict) – Arguments to use when visualizing the data. Arguments will be passed to visualize.export_to_firefly
  • run_id_selecting (bool) – If True, then run routines for selecting particles.
  • run_id_sampling (bool) – If True, then run routines for sampling from the full list of selected particles.
  • run_tracking (bool) – If True, then run routines for tracking particles.
  • run_galaxy_linking (bool) – If True, then run routines for associating particles with galaxies.
  • run_classifying (bool) – If True, then run routines for classifying particles.