McStasScript documentation

Getting started

  • Overview
  • Installation
  • Version history
  • Quick start

User guide

  • Instrument object
  • Component object
  • Parameters and variables
  • Data
  • Plotting
  • Functions
  • Widgets
  • Instrument reader

McStasScript Tutorial

  • McStasScript introduction
  • Advanced McStas features: SPLIT
  • Advanced McStas features: EXTEND and WHEN
  • Advanced McStas features: JUMP
  • Dynamic instrument cuts with MCPL bridges
  • Diagnostics

McStas Union Tutorial

  • The Union components
  • Advanced geometry using the Union components
  • Visualizing what happens in Union master
  • Using conditional component to modify loggers
  • Union tutorial on masks
  • Advanced geometry component concepts: Exit geometry and number of activations
  • Union tagging system

Reference

  • mcstasscript
    • mcstasscript.data
      • mcstasscript.data.MCPLDataFormat
        • mcstasscript.data.MCPLDataFormat.MCPLDataFormat
      • mcstasscript.data.McStasDataFormat
        • mcstasscript.data.McStasDataFormat.McStasFormat
      • mcstasscript.data.data
        • mcstasscript.data.data.McStasData
        • mcstasscript.data.data.McStasDataBinned
        • mcstasscript.data.data.McStasDataEvent
        • mcstasscript.data.data.McStasMetaData
        • mcstasscript.data.data.McStasPlotOptions
      • mcstasscript.data.pyvinylData
        • mcstasscript.data.pyvinylData.pyvinylMCPLData
        • mcstasscript.data.pyvinylData.pyvinylMcStasData
    • mcstasscript.helper
      • mcstasscript.helper.beam_dump_database
        • mcstasscript.helper.beam_dump_database.BeamDump
        • mcstasscript.helper.beam_dump_database.BeamDumpDatabase
      • mcstasscript.helper.check_mccode_version
        • mcstasscript.helper.check_mccode_version.check_mcstas_major_version
        • mcstasscript.helper.check_mccode_version.check_mcxtrace_major_version
      • mcstasscript.helper.component_reader
        • mcstasscript.helper.component_reader.c_integer_literal_base
        • mcstasscript.helper.component_reader.ComponentInfo
        • mcstasscript.helper.component_reader.ComponentReader
      • mcstasscript.helper.exceptions
        • mcstasscript.helper.exceptions.McStasError
      • mcstasscript.helper.formatting
        • mcstasscript.helper.formatting.is_legal_filename
        • mcstasscript.helper.formatting.is_legal_parameter
        • mcstasscript.helper.formatting.bcolors
      • mcstasscript.helper.managed_mcrun
        • mcstasscript.helper.managed_mcrun.findall
        • mcstasscript.helper.managed_mcrun.highlight
        • mcstasscript.helper.managed_mcrun.load_metadata
        • mcstasscript.helper.managed_mcrun.load_monitor
        • mcstasscript.helper.managed_mcrun.load_results
        • mcstasscript.helper.managed_mcrun.print_sim_output
        • mcstasscript.helper.managed_mcrun.ManagedMcrun
      • mcstasscript.helper.mcstas_objects
        • mcstasscript.helper.mcstas_objects.provide_parameter
        • mcstasscript.helper.mcstas_objects.write_parameter
        • mcstasscript.helper.mcstas_objects.Component
        • mcstasscript.helper.mcstas_objects.DeclareVariable
      • mcstasscript.helper.name_inspector
        • mcstasscript.helper.name_inspector.find_python_variable_name
      • mcstasscript.helper.plot_helper
      • mcstasscript.helper.search_statement
        • mcstasscript.helper.search_statement.SearchStatement
        • mcstasscript.helper.search_statement.SearchStatementList
      • mcstasscript.helper.unpickler
        • mcstasscript.helper.unpickler.CustomMcStasUnpickler
        • mcstasscript.helper.unpickler.CustomMcXtraceUnpickler
    • mcstasscript.instr_reader
      • mcstasscript.instr_reader.control
        • mcstasscript.instr_reader.control.InstrumentReader
      • mcstasscript.instr_reader.read_declare
        • mcstasscript.instr_reader.read_declare.DeclareReader
      • mcstasscript.instr_reader.read_definition
        • mcstasscript.instr_reader.read_definition.DefinitionReader
      • mcstasscript.instr_reader.read_finally
        • mcstasscript.instr_reader.read_finally.FinallyReader
      • mcstasscript.instr_reader.read_initialize
        • mcstasscript.instr_reader.read_initialize.InitializeReader
      • mcstasscript.instr_reader.read_trace
        • mcstasscript.instr_reader.read_trace.TraceReader
      • mcstasscript.instr_reader.read_uservars
        • mcstasscript.instr_reader.read_uservars.UservarsReader
      • mcstasscript.instr_reader.util
        • mcstasscript.instr_reader.util.SectionReader
    • mcstasscript.instrument_diagnostics
      • mcstasscript.instrument_diagnostics.beam_diagnostics
        • mcstasscript.instrument_diagnostics.beam_diagnostics.sanitise_comp_name
        • mcstasscript.instrument_diagnostics.beam_diagnostics.BeamDiagnostics
        • mcstasscript.instrument_diagnostics.beam_diagnostics.DiagnosticsPoint
      • mcstasscript.instrument_diagnostics.diagnostics_instrument
        • mcstasscript.instrument_diagnostics.diagnostics_instrument.DiagnosticsInstrument
      • mcstasscript.instrument_diagnostics.event_plotter
        • mcstasscript.instrument_diagnostics.event_plotter.EventPlotter
      • mcstasscript.instrument_diagnostics.intensity_diagnostics
        • mcstasscript.instrument_diagnostics.intensity_diagnostics.common_range_limits
        • mcstasscript.instrument_diagnostics.intensity_diagnostics.IntensityDiagnostics
      • mcstasscript.instrument_diagnostics.plot_overview
        • mcstasscript.instrument_diagnostics.plot_overview.PlotOverview
      • mcstasscript.instrument_diagnostics.view
        • mcstasscript.instrument_diagnostics.view.View
    • mcstasscript.instrument_diagram
      • mcstasscript.instrument_diagram.arrow
        • mcstasscript.instrument_diagram.arrow.Arrow
      • mcstasscript.instrument_diagram.box
        • mcstasscript.instrument_diagram.box.ComponentBox
      • mcstasscript.instrument_diagram.canvas
        • mcstasscript.instrument_diagram.canvas.DiagramCanvas
      • mcstasscript.instrument_diagram.component_description
        • mcstasscript.instrument_diagram.component_description.component_description
      • mcstasscript.instrument_diagram.connections
        • mcstasscript.instrument_diagram.connections.Connection
        • mcstasscript.instrument_diagram.connections.ConnectionList
        • mcstasscript.instrument_diagram.connections.IndexConnection
        • mcstasscript.instrument_diagram.connections.Lane
      • mcstasscript.instrument_diagram.generate_AT
        • mcstasscript.instrument_diagram.generate_AT.generate_AT_arrows
      • mcstasscript.instrument_diagram.generate_GROUP
        • mcstasscript.instrument_diagram.generate_GROUP.generate_GROUP_arrows
      • mcstasscript.instrument_diagram.generate_JUMP
        • mcstasscript.instrument_diagram.generate_JUMP.generate_JUMP_arrows
      • mcstasscript.instrument_diagram.generate_ROTATED
        • mcstasscript.instrument_diagram.generate_ROTATED.generate_ROTATED_arrows
      • mcstasscript.instrument_diagram.generate_Union
        • mcstasscript.instrument_diagram.generate_Union.generate_Union_arrows
      • mcstasscript.instrument_diagram.generate_target_index
        • mcstasscript.instrument_diagram.generate_target_index.generate_target_index_arrows
      • mcstasscript.instrument_diagram.make_diagram
        • mcstasscript.instrument_diagram.make_diagram.instrument_diagram
    • mcstasscript.integration_tests
      • mcstasscript.integration_tests.test_complex_instrument
        • mcstasscript.integration_tests.test_complex_instrument.setup_complex_instrument
        • mcstasscript.integration_tests.test_complex_instrument.FakeChange
        • mcstasscript.integration_tests.test_complex_instrument.TestComplexInstrument
      • mcstasscript.integration_tests.test_simple_instrument
        • mcstasscript.integration_tests.test_simple_instrument.setup_simple_instrument
        • mcstasscript.integration_tests.test_simple_instrument.setup_simple_instrument_input_path
        • mcstasscript.integration_tests.test_simple_instrument.setup_simple_slit_instrument
        • mcstasscript.integration_tests.test_simple_instrument.TestSimpleInstrument
    • mcstasscript.interface
      • mcstasscript.interface.functions
        • mcstasscript.interface.functions.load_data
        • mcstasscript.interface.functions.load_metadata
        • mcstasscript.interface.functions.load_monitor
        • mcstasscript.interface.functions.name_plot_options
        • mcstasscript.interface.functions.name_search
        • mcstasscript.interface.functions.Configurator
      • mcstasscript.interface.instr
        • mcstasscript.interface.instr.McCode_instr
        • mcstasscript.interface.instr.McStas_instr
        • mcstasscript.interface.instr.McXtrace_instr
      • mcstasscript.interface.plotter
        • mcstasscript.interface.plotter.make_animation
        • mcstasscript.interface.plotter.make_plot
        • mcstasscript.interface.plotter.make_sub_plot
      • mcstasscript.interface.reader
        • mcstasscript.interface.reader.McStas_file
    • mcstasscript.jb_interface
      • mcstasscript.jb_interface.plot_interface
        • mcstasscript.jb_interface.plot_interface.ColormapDropdown
        • mcstasscript.jb_interface.plot_interface.LogCheckbox
        • mcstasscript.jb_interface.plot_interface.MonitorDropdown
        • mcstasscript.jb_interface.plot_interface.OrdersOfMagField
        • mcstasscript.jb_interface.plot_interface.PlotInterface
      • mcstasscript.jb_interface.show_interface
        • mcstasscript.jb_interface.show_interface.show
        • mcstasscript.jb_interface.show_interface.show_instrunent
        • mcstasscript.jb_interface.show_interface.show_plot
      • mcstasscript.jb_interface.simulation_interface
        • mcstasscript.jb_interface.simulation_interface.add_data
        • mcstasscript.jb_interface.simulation_interface.ParameterWidget
        • mcstasscript.jb_interface.simulation_interface.SimInterface
      • mcstasscript.jb_interface.widget_helpers
        • mcstasscript.jb_interface.widget_helpers.get_parameter_default
        • mcstasscript.jb_interface.widget_helpers.parameter_has_default
        • mcstasscript.jb_interface.widget_helpers.HiddenPrints
    • mcstasscript.tests
      • mcstasscript.tests.helpers_for_tests
        • mcstasscript.tests.helpers_for_tests.WorkInTestDir
      • mcstasscript.tests.test_ComponentReader
        • mcstasscript.tests.test_ComponentReader.setup_component_reader
        • mcstasscript.tests.test_ComponentReader.setup_component_reader_input_path
        • mcstasscript.tests.test_ComponentReader.TestComponentReader
      • mcstasscript.tests.test_Configurator
        • mcstasscript.tests.test_Configurator.setup_configurator
        • mcstasscript.tests.test_Configurator.setup_expected_file
        • mcstasscript.tests.test_Configurator.TestConfigurator
      • mcstasscript.tests.test_Instr
        • mcstasscript.tests.test_Instr.insert_mock_dump
        • mcstasscript.tests.test_Instr.setup_instr_no_path
        • mcstasscript.tests.test_Instr.setup_instr_root_path
        • mcstasscript.tests.test_Instr.setup_instr_with_input_path
        • mcstasscript.tests.test_Instr.setup_instr_with_input_path_relative
        • mcstasscript.tests.test_Instr.setup_instr_with_path
        • mcstasscript.tests.test_Instr.setup_populated_instr
        • mcstasscript.tests.test_Instr.setup_populated_instr_with_dummy_MCPL_comps
        • mcstasscript.tests.test_Instr.setup_populated_instr_with_dummy_path
        • mcstasscript.tests.test_Instr.setup_populated_with_some_options_instr
        • mcstasscript.tests.test_Instr.setup_populated_x_ray_instr
        • mcstasscript.tests.test_Instr.setup_populated_x_ray_instr_with_dummy_path
        • mcstasscript.tests.test_Instr.setup_x_ray_instr_no_path
        • mcstasscript.tests.test_Instr.setup_x_ray_instr_root_path
        • mcstasscript.tests.test_Instr.setup_x_ray_instr_with_path
        • mcstasscript.tests.test_Instr.DummyComponent
        • mcstasscript.tests.test_Instr.TestMcStas_instr
      • mcstasscript.tests.test_Instr_reader
        • mcstasscript.tests.test_Instr_reader.blockPrint
        • mcstasscript.tests.test_Instr_reader.enablePrint
        • mcstasscript.tests.test_Instr_reader.set_dummy_dir
        • mcstasscript.tests.test_Instr_reader.setup_standard
        • mcstasscript.tests.test_Instr_reader.setup_standard_auto_instr
        • mcstasscript.tests.test_Instr_reader.TestInstrReader
      • mcstasscript.tests.test_ManagedMcrun
        • mcstasscript.tests.test_ManagedMcrun.TestManagedMcrun
        • mcstasscript.tests.test_ManagedMcrun.Test_load_functions
      • mcstasscript.tests.test_McStasData
        • mcstasscript.tests.test_McStasData.set_dummy_McStasDataBinned_1d
        • mcstasscript.tests.test_McStasData.set_dummy_McStasDataBinned_2d
        • mcstasscript.tests.test_McStasData.set_dummy_MetaDataBinned_1d
        • mcstasscript.tests.test_McStasData.set_dummy_MetaDataBinned_2d
        • mcstasscript.tests.test_McStasData.TestMcStasData
      • mcstasscript.tests.test_McStasMetaData
        • mcstasscript.tests.test_McStasMetaData.TestMcStasMetaData
      • mcstasscript.tests.test_McStasPlotOptions
        • mcstasscript.tests.test_McStasPlotOptions.TestMcStasPlotOptions
      • mcstasscript.tests.test_Plotter
        • mcstasscript.tests.test_Plotter.get_dummy_McStasDataBinned_1d
        • mcstasscript.tests.test_Plotter.get_dummy_McStasDataBinned_2d
        • mcstasscript.tests.test_Plotter.get_dummy_MetaDataBinned_1d
        • mcstasscript.tests.test_Plotter.get_dummy_MetaDataBinned_2d
        • mcstasscript.tests.test_Plotter.TestPlotterHelpers
      • mcstasscript.tests.test_add_data
        • mcstasscript.tests.test_add_data.set_dummy_McStasDataBinned_1d
        • mcstasscript.tests.test_add_data.set_dummy_McStasDataBinned_2d
        • mcstasscript.tests.test_add_data.set_dummy_MetaDataBinned_1d
        • mcstasscript.tests.test_add_data.set_dummy_MetaDataBinned_2d
        • mcstasscript.tests.test_add_data.Test_add_data
      • mcstasscript.tests.test_component
        • mcstasscript.tests.test_component.setup_Component_all_keywords
        • mcstasscript.tests.test_component.setup_Component_relative
        • mcstasscript.tests.test_component.setup_Component_with_parameters
        • mcstasscript.tests.test_component.TestComponent
      • mcstasscript.tests.test_declare_variable
        • mcstasscript.tests.test_declare_variable.Test_DeclareVariable
      • mcstasscript.tests.test_dump_and_load
        • mcstasscript.tests.test_dump_and_load.setup_instr_no_path
        • mcstasscript.tests.test_dump_and_load.setup_instr_root_path
        • mcstasscript.tests.test_dump_and_load.setup_instr_with_input_path
        • mcstasscript.tests.test_dump_and_load.setup_instr_with_input_path_relative
        • mcstasscript.tests.test_dump_and_load.setup_instr_with_path
        • mcstasscript.tests.test_dump_and_load.setup_populated_instr
        • mcstasscript.tests.test_dump_and_load.setup_populated_instr_with_dummy_path
        • mcstasscript.tests.test_dump_and_load.setup_populated_with_some_options_instr
        • mcstasscript.tests.test_dump_and_load.setup_populated_x_ray_instr
        • mcstasscript.tests.test_dump_and_load.setup_populated_x_ray_instr_with_dummy_path
        • mcstasscript.tests.test_dump_and_load.setup_x_ray_instr_no_path
        • mcstasscript.tests.test_dump_and_load.setup_x_ray_instr_root_path
        • mcstasscript.tests.test_dump_and_load.setup_x_ray_instr_with_path
        • mcstasscript.tests.test_dump_and_load.TestDumpAndLoad
      • mcstasscript.tests.test_formatting
        • mcstasscript.tests.test_formatting.TestFormatting
      • mcstasscript.tests.test_functions
        • mcstasscript.tests.test_functions.set_dummy_McStasDataBinned_1d
        • mcstasscript.tests.test_functions.set_dummy_McStasDataBinned_2d
        • mcstasscript.tests.test_functions.set_dummy_MetaDataBinned_1d
        • mcstasscript.tests.test_functions.set_dummy_MetaDataBinned_2d
        • mcstasscript.tests.test_functions.setup_McStasData_array
        • mcstasscript.tests.test_functions.setup_McStasData_array_repeat
        • mcstasscript.tests.test_functions.Test_load_data
        • mcstasscript.tests.test_functions.Test_load_metadata
        • mcstasscript.tests.test_functions.Test_load_monitor
        • mcstasscript.tests.test_functions.Test_name_plot_options
        • mcstasscript.tests.test_functions.Test_name_search
      • mcstasscript.tests.test_instrument_diagram
        • mcstasscript.tests.test_instrument_diagram.setup_boxes
        • mcstasscript.tests.test_instrument_diagram.setup_instr_no_path
        • mcstasscript.tests.test_instrument_diagram.setup_populated_instr
        • mcstasscript.tests.test_instrument_diagram.TestInstrumentDiagram
      • mcstasscript.tests.test_parameter_variable
        • mcstasscript.tests.test_parameter_variable.Test_ParameterVariable
      • mcstasscript.tests.test_plot_interface
        • mcstasscript.tests.test_plot_interface.fake_data
        • mcstasscript.tests.test_plot_interface.set_dummy_McStasDataBinned_1d
        • mcstasscript.tests.test_plot_interface.set_dummy_McStasDataBinned_2d
        • mcstasscript.tests.test_plot_interface.set_dummy_MetaDataBinned_1d
        • mcstasscript.tests.test_plot_interface.set_dummy_MetaDataBinned_2d
        • mcstasscript.tests.test_plot_interface.FakeChange
        • mcstasscript.tests.test_plot_interface.TestPlotInterface
      • mcstasscript.tests.test_simulation_interface
        • mcstasscript.tests.test_simulation_interface.setup_instr_root_path_McStas
        • mcstasscript.tests.test_simulation_interface.setup_instr_root_path_McXtrace
        • mcstasscript.tests.test_simulation_interface.setup_populated_instr_McStas
        • mcstasscript.tests.test_simulation_interface.setup_populated_instr_McXtrace
        • mcstasscript.tests.test_simulation_interface.FakeChange
        • mcstasscript.tests.test_simulation_interface.TestSimulationInterface
      • mcstasscript.tests.test_user_var
        • mcstasscript.tests.test_user_var.setup_instr_no_path
        • mcstasscript.tests.test_user_var.Test_user_vars
      • mcstasscript.tests.test_widget_helpers
        • mcstasscript.tests.test_widget_helpers.TestWidgetHelpers
      • mcstasscript.tests.utilities
        • mcstasscript.tests.utilities.work_dir_test
    • mcstasscript.tools
      • mcstasscript.tools.cryostat_builder
        • mcstasscript.tools.cryostat_builder.Cryostat
        • mcstasscript.tools.cryostat_builder.Layer
      • mcstasscript.tools.ncrystal_union
        • mcstasscript.tools.ncrystal_union.add_ncrystal_union_material

Reference (libpyvinyl)

  • libpyvinyl
    • libpyvinyl.AbstractBaseClass
      • libpyvinyl.AbstractBaseClass.AbstractBaseClass
    • libpyvinyl.BaseCalculator
    • libpyvinyl.BaseData
    • libpyvinyl.BaseFormat
      • libpyvinyl.BaseFormat.BaseFormat
    • libpyvinyl.Instrument
      • libpyvinyl.Instrument.Instrument
    • libpyvinyl.Parameters
      • libpyvinyl.Parameters.Collections
        • libpyvinyl.Parameters.Collections.quantity_decode
        • libpyvinyl.Parameters.Collections.quantity_encode
        • libpyvinyl.Parameters.Collections.CalculatorParameters
        • libpyvinyl.Parameters.Collections.InstrumentParameters
        • libpyvinyl.Parameters.Collections.MasterParameter
        • libpyvinyl.Parameters.Collections.MasterParameters
      • libpyvinyl.Parameters.Parameter
Theme by the Executable Book Project

mcstasscript.integration_tests

mcstasscript.integration_testsΒΆ

Modules

mcstasscript.integration_tests.test_complex_instrument

mcstasscript.integration_tests.test_simple_instrument

previous

mcstasscript.instrument_diagram.make_diagram.instrument_diagram

next

mcstasscript.integration_tests.test_complex_instrument

By Mads Bertelsen
© Copyright 2022, Mads Bertelsen.