Skip to main content
Ctrl+K

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.parse_coordinates
      • mcstasscript.data.data.ComponentData
      • 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.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.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.tools

Reference (libpyvinyl)

  • libpyvinyl
  • Repository
  • Suggest edit
  • Open issue
  • .rst

mcstasscript.data.McStasDataFormat

mcstasscript.data.McStasDataFormat#

Classes

McStasFormat()

previous

mcstasscript.data.MCPLDataFormat.MCPLDataFormat

next

mcstasscript.data.McStasDataFormat.McStasFormat

By Mads Bertelsen

© Copyright 2022, Mads Bertelsen.