bilby_pipe.job_creation.node
============================

.. py:module:: bilby_pipe.job_creation.node


Classes
-------

.. autoapisummary::

   bilby_pipe.job_creation.node.Node


Functions
---------

.. autoapisummary::

   bilby_pipe.job_creation.node._log_output_error_submit_lines


Module Contents
---------------

.. py:class:: Node(inputs, retry=None)

   Bases: :py:obj:`object`


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
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: run_node_on_osg
      :value: False



   .. py:attribute:: inputs


   .. py:attribute:: _universe
      :value: 'vanilla'



   .. py:attribute:: request_disk


   .. py:attribute:: notification


   .. py:attribute:: retry
      :value: None



   .. py:attribute:: verbose
      :value: 0



   .. py:attribute:: condor_job_priority


   .. py:attribute:: disable_hdf5_locking


   .. py:attribute:: extra_lines


   .. py:attribute:: requirements


   .. py:property:: universe


   .. py:method:: process_node()


   .. py:method:: _get_executable_path(exe_name)


   .. py:method:: setup_arguments(parallel_program=None, add_command_line_args=True, add_ini=True, add_unknown_args=True)


   .. py:property:: log_directory
      :abstractmethod:



   .. py:method:: create_pycondor_job()


   .. py:method:: add_accounting()

      
      Add the accounting-group and accounting-group-user extra lines
















      ..
          !! processed by numpydoc !!


   .. py:method:: _checkpoint_submit_lines()
      :staticmethod:



   .. py:method:: _condor_file_transfer_lines(inputs, outputs)
      :staticmethod:



   .. py:method:: _relative_topdir(path, reference)
      :staticmethod:


      
      Returns the top-level directory name of a path relative
      to a reference
















      ..
          !! processed by numpydoc !!


   .. py:method:: _osg_submit_options(executable, has_ligo_frames=False)

      
      Returns the extra submit lines and requirements to enable running
      a job on the Open Science Grid





      :Returns:

          **lines** : list
              the list of extra submit lines to include

          **requirements** : str
              the extra requirements line to include











      ..
          !! processed by numpydoc !!


   .. py:property:: slurm_walltime

      
      Default wall-time for base-name
















      ..
          !! processed by numpydoc !!


   .. py:property:: environment


.. py:function:: _log_output_error_submit_lines(logdir, prefix)

   
   Returns the filepaths for condor log, output, and error options


   :Parameters:

       **logdir** : str
           the target directory for the files

       **prefix** : str
           the prefix for the files



   :Returns:

       **log, output, error** : list of str
           the list of three file paths to be passed to pycondor.Job










   .. rubric:: Examples

   >>> Dag._log_output_error_submit_lines("test", "job")
   ['log = test/job.log',
    'output = test/job.out',
    'error = test/job.err']

   ..
       !! processed by numpydoc !!