bilby_pipe.job_creation.nodes
=============================

.. py:module:: bilby_pipe.job_creation.nodes


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/bilby_pipe/job_creation/nodes/analysis_node/index
   /autoapi/bilby_pipe/job_creation/nodes/final_result_node/index
   /autoapi/bilby_pipe/job_creation/nodes/generation_node/index
   /autoapi/bilby_pipe/job_creation/nodes/merge_node/index
   /autoapi/bilby_pipe/job_creation/nodes/pe_summary_node/index
   /autoapi/bilby_pipe/job_creation/nodes/plot_node/index
   /autoapi/bilby_pipe/job_creation/nodes/post_processing_node/index


Classes
-------

.. autoapisummary::

   bilby_pipe.job_creation.nodes.AnalysisNode
   bilby_pipe.job_creation.nodes.FinalResultNode
   bilby_pipe.job_creation.nodes.GenerationNode
   bilby_pipe.job_creation.nodes.MergeNode
   bilby_pipe.job_creation.nodes.PESummaryNode
   bilby_pipe.job_creation.nodes.PlotNode
   bilby_pipe.job_creation.nodes.PostProcessAllResultsNode
   bilby_pipe.job_creation.nodes.PostProcessSingleResultsNode


Package Contents
----------------

.. py:class:: AnalysisNode(inputs, generation_node, detectors, sampler, parallel_idx, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: run_node_on_osg
      :value: True



   .. py:attribute:: dag


   .. py:attribute:: generation_node


   .. py:attribute:: detectors


   .. py:attribute:: parallel_idx


   .. py:attribute:: request_cpus


   .. py:attribute:: base_job_name


   .. py:attribute:: label


   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


   .. py:property:: result_file


   .. py:property:: slurm_walltime

      
      Default wall-time for base-name
















      ..
          !! processed by numpydoc !!


.. py:class:: FinalResultNode(inputs, parent_node, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: run_node_on_osg
      :value: True



   .. py:attribute:: dag


   .. py:attribute:: request_cpus
      :value: 1



   .. py:attribute:: job_name


   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


.. py:class:: GenerationNode(inputs, trigger_time, idx, dag, parent=None)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: inputs


   .. py:attribute:: trigger_time


   .. py:attribute:: idx


   .. py:attribute:: dag


   .. py:attribute:: request_cpus
      :value: 1



   .. py:property:: resolve_frame_files

      
      Resolve frame files from frame_type_dict and data_dict.
      For each detector, if the frame filepath(s) is given
      return the filepath(s), otherwise use gwdatafind to
      resolve the frame files using the provided frame type.





      :Returns:

          output: list
              list of frame filepaths

          success: bool
              True if frame files are resolved successfully for all detectors











      ..
          !! processed by numpydoc !!


   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


   .. py:property:: universe


   .. py:property:: job_name


   .. py:property:: label


   .. py:property:: data_dump_file


.. py:class:: MergeNode(inputs, parallel_node_list, detectors, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: run_node_on_osg
      :value: True



   .. py:attribute:: dag


   .. py:attribute:: job_name


   .. py:attribute:: label


   .. py:attribute:: request_cpus
      :value: 1



   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


   .. py:property:: result_file


.. py:class:: PESummaryNode(inputs, merged_node_list, generation_node_list, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: run_node_on_osg
      :value: True



   .. py:attribute:: dag


   .. py:attribute:: job_name


   .. py:attribute:: request_cpus
      :value: 1



   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


.. py:class:: PlotNode(inputs, merged_node, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: run_node_on_osg
      :value: True



   .. py:attribute:: dag


   .. py:attribute:: job_name


   .. py:attribute:: label


   .. py:attribute:: request_cpus
      :value: 1



   .. py:property:: data_dump_file


   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


   .. py:property:: universe


.. py:class:: PostProcessAllResultsNode(inputs, merged_node_list, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: dag


   .. py:attribute:: request_cpus
      :value: 1



   .. py:attribute:: job_name


   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory


.. py:class:: PostProcessSingleResultsNode(inputs, merged_node, dag)

   Bases: :py:obj:`bilby_pipe.job_creation.node.Node`


   
   Base Node object, handles creation of arguments, executables, etc
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: dag


   .. py:attribute:: request_cpus
      :value: 1



   .. py:attribute:: job_name


   .. py:property:: executable


   .. py:property:: request_memory


   .. py:property:: log_directory