Skip to main content
Ctrl+K
Logo image Logo image
  • Downloads
  • Tutorials
  • User Docs
  • Develop
  • Release notes
  • Forums
  • Contact Us
  • Downloads
  • Tutorials
  • User Docs
  • Develop
  • Release notes
  • Forums
  • Contact Us

Section Navigation

  • Python API
    • mantid
      • apiVersion
      • mantid.kernel
        • amend_config
        • Atom
        • BoolFilteredTimeSeriesProperty
        • BoolPropertyWithValue
        • BoolTimeSeriesProperty
        • CIntArrayProperty
        • CompositeValidator
        • ConfigObserver
        • ConfigPropertyObserver
        • ConfigServiceImpl
        • DataItem
        • DateAndTime
        • DeltaEMode
        • DeltaEModeType
        • Direction
        • EnabledWhenProperty
        • FacilityInfo
        • FloatArrayBoundedValidator
        • FloatArrayLengthValidator
        • FloatArrayMandatoryValidator
        • FloatArrayProperty
        • FloatBoundedValidator
        • FloatFilteredTimeSeriesProperty
        • FloatMandatoryValidator
        • FloatPropertyWithValue
        • FloatTimeSeriesProperty
        • IPropertyManager
        • IPropertySettings
        • IValidator
        • InstrumentInfo
        • Int32FilteredTimeSeriesProperty
        • Int32TimeSeriesProperty
        • Int64FilteredTimeSeriesProperty
        • Int64TimeSeriesProperty
        • IntArrayBoundedValidator
        • IntArrayLengthValidator
        • IntArrayMandatoryValidator
        • IntArrayProperty
        • IntBoundedValidator
        • IntListValidator
        • IntMandatoryValidator
        • IntPropertyWithValue
        • Label
        • LiveListenerInfo
        • LogFilter
        • Logger
        • LongLongPropertyWithValue
        • LongPropertyWithValue
        • Material
        • MaterialBuilder
        • MemoryStats
        • NullValidator
        • NumberDensityUnit
        • ProgressBase
        • Property
        • PropertyCriterion
        • PropertyHistory
        • PropertyManager
        • PropertyManagerDataServiceImpl
        • PropertyManagerProperty
        • PythonObjectProperty
        • PythonObjectTypeValidator
        • Quat
        • RebinParamsValidator
        • Stats
        • StringArrayLengthValidator
        • StringArrayMandatoryValidator
        • StringArrayProperty
        • StringContainsValidator
        • StringFilteredTimeSeriesProperty
        • StringListValidator
        • StringMandatoryValidator
        • StringPropertyWithValue
        • StringTimeSeriesProperty
        • TimeSeriesProperty
        • TimeSeriesPropertyStatistics
        • UIntPropertyWithValue
        • ULongLongPropertyWithValue
        • ULongPropertyWithValue
        • Unit
        • UnitConversion
        • UnitFactoryImpl
        • UnitLabel
        • UnsignedIntArrayProperty
        • V3D
        • VMD
        • VectorBoolPropertyWithValue
        • VectorFloatPropertyWithValue
        • VectorIntPropertyWithValue
        • VectorLongLongPropertyWithValue
        • VectorLongPropertyWithValue
        • VectorStringPropertyWithValue
        • VectorUIntPropertyWithValue
        • VectorULongLongPropertyWithValue
        • VectorULongPropertyWithValue
        • VisibleWhenProperty
        • std_set_int
        • std_set_str
        • std_vector_InstrumentInfo
        • std_vector_bool
        • std_vector_dateandtime
        • std_vector_dbl
        • std_vector_facilityinfo
        • std_vector_int
        • std_vector_long
        • std_vector_property
        • std_vector_size_t
        • std_vector_str
        • time_duration
      • mantid.dataobjects
        • EventList
        • EventWorkspace
        • EventWorkspaceProperty
        • GroupingWorkspace
        • GroupingWorkspaceProperty
        • LeanElasticPeaksWorkspace
        • MDEventWorkspace
        • MDHistoWorkspace
        • MDLeanEventWorkspace
        • MaskWorkspace
        • MaskWorkspaceProperty
        • NoShape
        • OffsetsWorkspace
        • OffsetsWorkspaceProperty
        • PeakShapeDetectorBin
        • PeakShapeEllipsoid
        • PeakShapeSpherical
        • PeaksWorkspace
        • PeaksWorkspaceProperty
        • RebinnedOutput
        • SpecialWorkspace2D
        • SpecialWorkspace2DProperty
        • SplittersWorkspace
        • SplittersWorkspaceProperty
        • TableWorkspace
        • TableWorkspaceProperty
        • Workspace2D
        • Workspace2DProperty
        • WorkspaceSingleValue
        • WorkspaceSingleValueProperty
      • mantid.geometry
        • AngleUnits
        • BoundingBox
        • CompAssembly
        • Component
        • ComponentInfo
        • Detector
        • DetectorGroup
        • DetectorInfo
        • Goniometer
        • GridDetectorPixel
        • ICompAssembly
        • IComponent
        • IDetector
        • IMDDimension
        • IObjCompAssembly
        • IObjComponent
        • Object
        • Instrument
        • ObjComponent
        • OrientedLattice
        • PointingAlong
        • RectangularDetector
        • ReferenceFrame
        • UnitCell
      • mantid.api
        • AlgoTimeRegister
        • Algorithm
        • AlgorithmFactoryImpl
        • AlgorithmHistory
        • AlgorithmID
        • AlgorithmManagerImpl
        • AlgorithmProperty
        • AlgorithmPropertyWithValue
        • AnalysisDataServiceImpl
        • BinEdgeAxis
        • BoxController
        • CommonBinsValidator
        • DataProcessorAlgorithm
        • DeprecatedAlgorithmChecker
        • EventType
        • ExperimentInfo
        • ExperimentInfoValidator
        • FileAction
        • FileFinderImpl
        • FileProperty
        • FrameworkManagerImpl
        • FunctionFactoryImpl
        • FunctionProperty
        • FunctionPropertyWithValue
        • HistogramValidator
        • IAlgorithm
        • IEventList
        • IEventWorkspace
        • IEventWorkspaceProperty
        • IEventWorkspacePropertyPropertyWithValue
        • IFunction
        • IFunction1D
        • IMDEventWorkspace
        • IMDHistoWorkspace
        • IMDHistoWorkspaceProperty
        • IMDHistoWorkspacePropertyPropertyWithValue
        • IMDWorkspace
        • IPeak
        • IPeakFunction
        • IPeaksWorkspace
        • IPeaksWorkspaceProperty
        • ISpectrum
        • Splitters Workspace
        • ITableWorkspace
        • ITableWorkspaceProperty
        • ITableWorkspacePropertyPropertyWithValue
        • IWorkspaceProperty
        • InstrumentValidator
        • Jacobian
        • LockMode
        • MDGeometry
        • MDNormalization
        • MantidAxis
        • MatrixWorkspace
        • MatrixWorkspaceProperty
        • MatrixWorkspacePropertyPropertyWithValue
        • MatrixWorkspaceValidator
        • MultipleExperimentInfos
        • MultipleFileProperty
        • NumericAxis
        • NumericAxisValidator
        • Progress
        • PropertyMode
        • RawCountValidator
        • Run
        • Sample
        • ScriptRepository
        • ScriptRepositoryFactory
        • SpectraAxisValidator
        • SpectrumInfo
        • TextAxis
        • VectorVectorStringPropertyWithValue
        • Workspace
        • WorkspaceFactoryImpl
        • WorkspaceGroup
        • WorkspaceGroupProperty
        • WorkspaceGroupPropertyPropertyWithValue
        • WorkspaceHistory
        • WorkspaceProperty
        • WorkspacePropertyPropertyWithValue
        • WorkspaceUnitValidator
      • mantid.plots
      • mantid.utils
        • Reflectometry Utilities
      • mantid.testing
        • assert_almost_equal
        • assert_not_equal
      • mantid.simpleapi — Simple functions calls for mantid algorithms
      • mantid.fitfunctions — Wrapper class for composite fitting function
      • mantid.fixtures — Pytest Fixtures for projects that use Mantid
    • changes
  • API
  • Python API
  • mantid — Framework package

mantid — Framework package#

This package defines the Python interface to the Mantid C++ framework libraries for actions such as running algorithms and accessing workspaces etc.

Functions#

  • apiVersion

Submodules#

  • mantid.kernel
  • mantid.dataobjects
  • mantid.geometry
  • mantid.api
  • mantid.plots
  • mantid.utils
  • mantid.testing
  • mantid.simpleapi — Simple functions calls for mantid algorithms
  • mantid.fitfunctions — Wrapper class for composite fitting function
  • mantid.fixtures — Pytest Fixtures for projects that use Mantid

previous

Python API

next

apiVersion

On this page
  • Functions
  • Submodules

This Page

  • Show Source

© Copyright 2026, Mantid.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.16.1.