Python API documentation

Every module in the MagritteTorch package is documented here. This contains all the classes and functions that are available to the user. Model setup can be done using the Model class and setting all necessary variables according to the examples. The solvers module contains high-level routines for line radiative transfer computations. The plot module aids with visualizing the results of the simulations.

Main operations on a model and utilities for model setup:

• magrittetorch.algorithms.solvers
  • compute_level_populations()
  • image_model()
• magrittetorch.tools.setup
  • LamdaFileReader
    • LamdaFileReader.extractCollisionPartner()
    • LamdaFileReader.readColumn()
  • create_rotation_matrix()
  • getSpeciesNumber()
  • getSpeciesNumberList()
  • set_Delaunay_boundary()
  • set_Delaunay_neighbor_lists()
  • set_boundary_condition_1D()
  • set_boundary_condition_CMB()
  • set_boundary_condition_zero()
  • set_linedata_from_LAMDA_file()
  • set_quadrature()
  • set_rays_spherical_symmetry()
  • set_uniform_rays()
• magrittetorch.tools.mesher
  • point_cloud_add_spherical_outer_boundary()
  • remesh_point_cloud()
• magrittetorch.tools.plot
  • image_channel()
  • image_mpl()
  • image_plotly()
  • save_fits()

Note

In the documentation of the class variables, you might see the following notation:

• dtype: the datatype of the variable

• dims: the dimensions of the variable, can be a list of (integers, parameter values) or None

• unit: the astropy unit of the variable

Classes pertaining to the model data:

• magrittetorch.model.model
  • Model
    • Model.__init__()
    • Model.get_boundary_intensity()
    • Model.read()
    • Model.write()
    • Model.chemistry
    • Model.dataCollection
    • Model.geometry
    • Model.images
    • Model.io
    • Model.parameters
    • Model.sources
    • Model.thermodynamics
• magrittetorch.model.image
  • ImageType
    • ImageType.Intensity
    • ImageType.OpticalDepth
  • Image
    • Image.I
    • Image.freqs
    • Image.imX
    • Image.imY
    • Image.imageType
    • Image.image_direction_x
    • Image.image_direction_y
    • Image.image_direction_z
    • Image.nfreqs
    • Image.npix
• magrittetorch.utils.io
  • IO
    • IO.read()
    • IO.write()
    • IO.save_location
• magrittetorch.utils.storagetypes
  • DataCollection
    • DataCollection.infer_data()
    • DataCollection.is_data_complete()
  • DelayedListOfClassInstances
    • DelayedListOfClassInstances.__getitem__()
    • DelayedListOfClassInstances.get()
  • InferredTensor
    • InferredTensor.__init__()
    • InferredTensor.get()
    • InferredTensor.get_astropy()
    • InferredTensor.get_type()
    • InferredTensor.infer()
    • InferredTensor.is_complete()
    • InferredTensor.set()
    • InferredTensor.set_astropy()
  • InferredTensorPerNLTEIter
    • InferredTensorPerNLTEIter.__init__()
    • InferredTensorPerNLTEIter.get()
    • InferredTensorPerNLTEIter.get_astropy()
    • InferredTensorPerNLTEIter.get_type()
    • InferredTensorPerNLTEIter.infer()
    • InferredTensorPerNLTEIter.is_complete()
    • InferredTensorPerNLTEIter.set()
    • InferredTensorPerNLTEIter.set_astropy()
  • StorageNdarray
    • StorageNdarray.__init__()
    • StorageNdarray.get()
    • StorageNdarray.get_astropy()
    • StorageNdarray.get_type()
    • StorageNdarray.is_complete()
    • StorageNdarray.set()
    • StorageNdarray.set_astropy()
  • StorageTensor
    • StorageTensor.__init__()
    • StorageTensor.get()
    • StorageTensor.get_astropy()
    • StorageTensor.get_type()
    • StorageTensor.is_complete()
    • StorageTensor.set()
    • StorageTensor.set_astropy()
  • Types
    • Types.Bool
    • Types.Enum
    • Types.FrequencyInfo
    • Types.GeometryInfo
    • Types.IndexInfo
    • Types.LevelPopsInfo
    • Types.NpString
• magrittetorch.model.parameters
  • Parameter
    • Parameter.get()
    • Parameter.set()
    • Parameter.name
    • Parameter.value
  • EnumParameter
    • EnumParameter.get_enum_type()
  • Parameters
    • Parameters.nboundary
    • Parameters.nlspecs
    • Parameters.npoints
    • Parameters.nrays
    • Parameters.nspecs
• magrittetorch.model.geometry.geometry
  • GeometryType
    • GeometryType.General3D
    • GeometryType.SpericallySymmetric1D
  • Geometry
    • Geometry.boundary
    • Geometry.geometryType
    • Geometry.points
    • Geometry.rays
• magrittetorch.model.geometry.points
  • Points
    • Points.n_neighbors
    • Points.neighbors
    • Points.position
    • Points.velocity
• magrittetorch.model.geometry.boundary
  • BoundaryCondition
    • BoundaryCondition.Zero
    • BoundaryCondition.Thermal
    • BoundaryCondition.CMB
  • BoundaryType
    • BoundaryType.Sphere1D
    • BoundaryType.Sphere3D
    • BoundaryType.AxisAlignedCube
  • Boundary
    • Boundary.boundary2point
    • Boundary.boundaryType
    • Boundary.boundary_condition
    • Boundary.boundary_temperature
    • Boundary.center
    • Boundary.is_boundary_point
    • Boundary.point2boundary
• magrittetorch.model.geometry.rays
  • Rays
    • Rays.direction
    • Rays.weight
• magrittetorch.model.chemistry.chemistry
  • Chemistry
    • Chemistry.species
• magrittetorch.model.chemistry.species
  • Species
    • Species.abundance
    • Species.symbol
• magrittetorch.model.sources.sources
  • Sources
    • Sources.lines
• magrittetorch.model.sources.lines
  • Lines
    • Lines.lineProducingSpecies
• magrittetorch.model.sources.lineproducingspecies
  • LineProducingSpecies
    • LineProducingSpecies.compute_line_cooling()
    • LineProducingSpecies.line_opacities
    • LineProducingSpecies.linedata
    • LineProducingSpecies.linequadrature
    • LineProducingSpecies.population
    • LineProducingSpecies.population_tot
    • LineProducingSpecies.sorted_linefreqs
    • LineProducingSpecies.sorted_linewidths
• magrittetorch.model.sources.linedata
  • Linedata
    • Linedata.A
    • Linedata.Ba
    • Linedata.Bs
    • Linedata.colpar
    • Linedata.energy
    • Linedata.frequency
    • Linedata.inverse_mass
    • Linedata.irad
    • Linedata.jrad
    • Linedata.ncolpar
    • Linedata.nlev
    • Linedata.nrad
    • Linedata.num
    • Linedata.sym
    • Linedata.weight
• magrittetorch.model.sources.collisionpartner
  • CollisionPartner
    • CollisionPartner.Cd
    • CollisionPartner.Ce
    • CollisionPartner.icol
    • CollisionPartner.jcol
    • CollisionPartner.ncol
    • CollisionPartner.ntmp
    • CollisionPartner.num_col_partner
    • CollisionPartner.orth_or_para_H2
    • CollisionPartner.tmp

And then some utility functions and classes:

• magrittetorch.utils.logger
  • Level
    • Level.DEBUG
    • Level.INFO
    • Level.WARNING
    • Level.ERROR
  • Logger
    • Logger.log()
    • Logger.default_level
• magrittetorch.utils.memorymapping
  • MemoryManager
    • MemoryManager.run_with_splitting()
• magrittetorch.tools.timer
  • Timer
    • Timer.print()
    • Timer.start()
    • Timer.stop()

Note

This API documentation only includes methods and classes that are part of the public API. You are free to use any other method of any class, but be aware that these might change in future releases.