SHERLOCK PIPEline

Contents:

  • Installation
  • SHERLOCK PIPEline
  • SHERLOCK PIPEline: Programmatic API
    • sherlockpipe
      • sherlockpipe.no_verify_request
      • sherlockpipe.bayesian_fit
      • sherlockpipe.catalog
      • sherlockpipe.constants
      • sherlockpipe.fit
      • sherlockpipe.loading
      • sherlockpipe.maxsector
      • sherlockpipe.moriarty
      • sherlockpipe.observation_plan
      • sherlockpipe.ois
      • sherlockpipe.plan
      • sherlockpipe.plot
      • sherlockpipe.scoring
      • sherlockpipe.search
        • sherlockpipe.search.BlsSearcher
        • sherlockpipe.search.Searcher
        • sherlockpipe.search.TlsSearcher
        • sherlockpipe.search.phase_coverage
        • sherlockpipe.search.run
        • sherlockpipe.search.sherlock
        • sherlockpipe.search.sherlock_target
        • sherlockpipe.search.transitresult
      • sherlockpipe.search_zones
      • sherlockpipe.single_transits
      • sherlockpipe.stability
      • sherlockpipe.system_stability
      • sherlockpipe.tidal
      • sherlockpipe.ttvs
      • sherlockpipe.update
      • sherlockpipe.vet
      • sherlockpipe.vetting
  • Fit Module
  • Vet Module
  • Stability Module
  • Plan Module
  • Tutorials
  • Who we are
SHERLOCK PIPEline
  • SHERLOCK PIPEline: Programmatic API
  • sherlockpipe
  • sherlockpipe.search
  • sherlockpipe.search.run
  • sherlockpipe.search.run.run_search
  • View page source

sherlockpipe.search.run.run_search

sherlockpipe.search.run.run_search(properties: str, explore: bool, results_dir: None, cpus: int = None)

Executes the SHERLOCK search reading the given properties file.

Parameters:
  • properties – the properties directory

  • explore – whether SHERLOCK should run only the steps previous to the search.

  • cpus – the number of processes to be used

  • results_dir – the output directory to store the results

Return dict:

the final used properties dictionary

Previous Next

© Copyright 2021, Martín Dévora-Pajares & Francisco J. Pozuelos.

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