mcstasscript.interface.instr.McStas\_instr
==========================================

.. currentmodule:: mcstasscript.interface.instr

.. autoclass:: McStas_instr
   :members:

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~McStas_instr.__init__
      ~McStas_instr.add_component
      ~McStas_instr.add_declare_var
      ~McStas_instr.add_parameter
      ~McStas_instr.add_search
      ~McStas_instr.add_user_var
      ~McStas_instr.append_declare
      ~McStas_instr.append_finally
      ~McStas_instr.append_finally_no_new_line
      ~McStas_instr.append_initialize
      ~McStas_instr.append_initialize_no_new_line
      ~McStas_instr.append_trace
      ~McStas_instr.append_trace_no_new_line
      ~McStas_instr.available_components
      ~McStas_instr.backengine
      ~McStas_instr.check_for_errors
      ~McStas_instr.check_for_relative_errors
      ~McStas_instr.clear_search
      ~McStas_instr.component_help
      ~McStas_instr.copy_component
      ~McStas_instr.dump
      ~McStas_instr.from_dump
      ~McStas_instr.get_component
      ~McStas_instr.get_component_subset_index_range
      ~McStas_instr.get_last_component
      ~McStas_instr.get_parameter_names
      ~McStas_instr.has_errors
      ~McStas_instr.init_parameters
      ~McStas_instr.make_component_subset
      ~McStas_instr.move_component
      ~McStas_instr.move_user_vars_to_declare
      ~McStas_instr.print_component
      ~McStas_instr.print_component_short
      ~McStas_instr.print_components
      ~McStas_instr.read_instrument_file
      ~McStas_instr.remove_component
      ~McStas_instr.reset_parameters
      ~McStas_instr.reset_run_points
      ~McStas_instr.run_from
      ~McStas_instr.run_full_instrument
      ~McStas_instr.run_to
      ~McStas_instr.saveH5
      ~McStas_instr.set_calculator_base_dir
      ~McStas_instr.set_dependency
      ~McStas_instr.set_input
      ~McStas_instr.set_instrument_base_dir
      ~McStas_instr.set_output_data_types
      ~McStas_instr.set_output_filenames
      ~McStas_instr.set_output_keys
      ~McStas_instr.set_parameters
      ~McStas_instr.settings
      ~McStas_instr.settings_string
      ~McStas_instr.show_analysis
      ~McStas_instr.show_components
      ~McStas_instr.show_diagram
      ~McStas_instr.show_dump
      ~McStas_instr.show_dumps
      ~McStas_instr.show_instrument
      ~McStas_instr.show_instrument_file
      ~McStas_instr.show_parameters
      ~McStas_instr.show_run_subset
      ~McStas_instr.show_search
      ~McStas_instr.show_settings
      ~McStas_instr.show_variables
      ~McStas_instr.subset_check
      ~McStas_instr.write_c_files
      ~McStas_instr.write_full_instrument
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~McStas_instr.base_dir
      ~McStas_instr.calculator_base_dir
      ~McStas_instr.data
      ~McStas_instr.input
      ~McStas_instr.instrument_base_dir
      ~McStas_instr.name
      ~McStas_instr.output
      ~McStas_instr.output_data_types
      ~McStas_instr.output_file_paths
      ~McStas_instr.output_filenames
      ~McStas_instr.output_keys
      ~McStas_instr.output_path
      ~McStas_instr.parameters