mcio

Menu

  • Installation
    • End user installation
    • Dev installation
    • OpenMC
    • Conda installation for CadQuery-OCP
  • User guide
    • 1. Building CSG models
      • 1.1. Writing using CSG
        • 1.1.1. Import modules
        • 1.1.2. Volumes
        • 1.1.3. Materials
        • 1.1.4. Cells
        • 1.1.5. Sources
        • 1.1.6. Tallies
        • 1.1.7. MCNP parameters
        • 1.1.8. Model
        • 1.1.9. CSG-to-CAD
    • 2. CAD-to-CSG decomposition
      • 2.1. Running from the command line
      • 2.2. Running via the Python API
        • 2.2.1. Single core example
        • 2.2.2. Multiprocess example
        • 2.2.3. Assigning materials
        • 2.2.4. Debugging problem solids
        • 2.2.5. Altering the decomposition parameters
  • API Reference
    • mcio.surface
      • ConeOnXAxis
        • ConeOnXAxis.mcnp_card
        • ConeOnXAxis.openmc_surface
      • ConeOnYAxis
        • ConeOnYAxis.mcnp_card
        • ConeOnYAxis.openmc_surface
      • ConeOnZAxis
        • ConeOnZAxis.mcnp_card
        • ConeOnZAxis.openmc_surface
      • ConeParallelToXAxis
        • ConeParallelToXAxis.mcnp_card
        • ConeParallelToXAxis.openmc_surface
      • ConeParallelToYAxis
        • ConeParallelToYAxis.mcnp_card
        • ConeParallelToYAxis.openmc_surface
      • ConeParallelToZAxis
        • ConeParallelToZAxis.mcnp_card
        • ConeParallelToZAxis.openmc_surface
      • CylinderOnXAxis
        • CylinderOnXAxis.mcnp_card
        • CylinderOnXAxis.openmc_surface
      • CylinderOnYAxis
        • CylinderOnYAxis.mcnp_card
        • CylinderOnYAxis.openmc_surface
      • CylinderOnZAxis
        • CylinderOnZAxis.mcnp_card
        • CylinderOnZAxis.openmc_surface
      • CylinderParallelToXAxis
        • CylinderParallelToXAxis.mcnp_card
        • CylinderParallelToXAxis.openmc_surface
      • CylinderParallelToYAxis
        • CylinderParallelToYAxis.mcnp_card
        • CylinderParallelToYAxis.openmc_surface
      • CylinderParallelToZAxis
        • CylinderParallelToZAxis.mcnp_card
        • CylinderParallelToZAxis.openmc_surface
      • Ellipsoid
        • Ellipsoid.mcnp_card
      • GeneralQuadratic
        • GeneralQuadratic.mcnp_card
        • GeneralQuadratic.openmc_surface
      • Plane
        • Plane.mcnp_card
        • Plane.openmc_surface
      • PlaneFromThreePoints
        • PlaneFromThreePoints.mcnp_card
      • Sphere
        • Sphere.mcnp_card
        • Sphere.openmc_surface
        • Sphere.serpent_card
      • SphereAtOrigin
        • SphereAtOrigin.mcnp_card
        • SphereAtOrigin.openmc_surface
      • SphereOnXAxis
        • SphereOnXAxis.mcnp_card
        • SphereOnXAxis.openmc_surface
      • SphereOnYAxis
        • SphereOnYAxis.mcnp_card
        • SphereOnYAxis.openmc_surface
      • SphereOnZAxis
        • SphereOnZAxis.mcnp_card
        • SphereOnZAxis.openmc_surface
      • Surface
        • Surface.from_mcnp_card()
      • ToriParralleltoXAxis
        • ToriParralleltoXAxis.mcnp_card
        • ToriParralleltoXAxis.openmc_surface
      • ToriParralleltoYAxis
        • ToriParralleltoYAxis.mcnp_card
        • ToriParralleltoYAxis.openmc_surface
      • ToriParralleltoZAxis
        • ToriParralleltoZAxis.mcnp_card
        • ToriParralleltoZAxis.openmc_surface
      • XPlane
        • XPlane.mcnp_card
        • XPlane.openmc_surface
      • YPlane
        • YPlane.mcnp_card
        • YPlane.openmc_surface
      • ZPlane
        • ZPlane.mcnp_card
        • ZPlane.openmc_surface
      • mcnp_surface()
      • openmc_boundary_type()
      • serpent_surface()
    • mcio.volume
      • And
        • And.mcnp_string
        • And.ocp_solid()
        • And.openmc_region
      • Boolean
        • Boolean.replace_duplicate_surfaces()
        • Boolean.sub_booleans
        • Boolean.surfaces
      • HalfVolume
        • HalfVolume.direction
        • HalfVolume.mcnp_string
        • HalfVolume.ocp_solid()
        • HalfVolume.openmc_region
        • HalfVolume.replace_duplicate_surfaces()
        • HalfVolume.surface
        • HalfVolume.surfaces
        • HalfVolume.volume
      • Or
        • Or.mcnp_string
        • Or.ocp_solid()
        • Or.openmc_region
      • Volume
        • Volume.boolean
        • Volume.mcnp_string
        • Volume.ocp_solid()
        • Volume.openmc_region
        • Volume.replace_duplicate_surfaces()
        • Volume.surfaces
        • Volume.volume
    • mcio.material
      • Material
        • Material.elements
        • Material.from_mcnp_card()
        • Material.gdml_xml_tag
        • Material.isotopes
        • Material.mcnp_card
        • Material.openmc_material
        • Material.serpent2_card
        • Material.strip_isotopes()
      • Materials
        • Materials.elements
        • Materials.gdml_xml_tag
        • Materials.isotopes
        • Materials.materials
      • openmc_material_to_mcio_material()
    • mcio.tally
      • CellOrSurfaceTally
        • CellOrSurfaceTally.mcnp_card
        • CellOrSurfaceTally.openmc_tally
        • CellOrSurfaceTally.target_numbers
      • EnergyDepositionTally
      • FluenceMeshTally
        • FluenceMeshTally.from_bounding_box()
        • FluenceMeshTally.mcnp_card
        • FluenceMeshTally.openmc_tally
      • PulseHeightTally
      • SurfaceCurrent
      • SurfaceFluenceTally
      • Tally
        • Tally.from_dict()
      • VolumeFluenceTally
    • mcio.source
      • CircularPlaneParrallel
        • CircularPlaneParrallel.mcnp_card
      • IsotropicCylindricalVolume
        • IsotropicCylindricalVolume.mcnp_card
      • MCNPSourceFromFile
        • MCNPSourceFromFile.file_path
        • MCNPSourceFromFile.mcnp_card
      • Point
        • Point.mcnp_card
        • Point.position
      • RectangularParallelepipedVolume
        • RectangularParallelepipedVolume.mcnp_card
      • Source
        • Source.energy
        • Source.particle
      • SourceEnergyDistribution
        • SourceEnergyDistribution.mcnp_subcards
      • SourcePositionDistribution
        • SourcePositionDistribution.mcnp_subcards
      • SphericalStochasticVolumeSource
        • SphericalStochasticVolumeSource.mcnp_card
    • mcio.cell
      • Cell
        • Cell.material
        • Cell.mcnp_card
        • Cell.ocp_solid()
        • Cell.openmc_cell
        • Cell.surfaces
    • mcio.model
      • Model
        • Model.add_cells()
        • Model.add_material()
        • Model.add_materials()
        • Model.cell_number_min
        • Model.gdml_string
        • Model.materials
        • Model.mcnp_string
        • Model.openmc_model
        • Model.serpent_string
        • Model.surface_number_min
        • Model.tallies
        • Model.write_gdml()
        • Model.write_mcnp()
        • Model.write_openmc()
        • Model.write_serpent()
    • mcio.mcnp
      • MCNPCard
        • MCNPCard.add_row()
        • MCNPCard.add_subcard()
        • MCNPCard.as_string
      • MCNPCardHeader
        • MCNPCardHeader.as_string
      • MCNPCellParameters
        • MCNPCellParameters.graveyard
        • MCNPCellParameters.importances
        • MCNPCellParameters.volume
      • MCNPHeader
        • MCNPHeader.as_string
      • MCNPMaterialParameters
        • MCNPMaterialParameters.sab_cards
        • MCNPMaterialParameters.libs
        • MCNPMaterialParameters.library
        • MCNPMaterialParameters.library_by_isotope
      • MCNPRunParameters
        • MCNPRunParameters.forced_collisions
        • MCNPRunParameters.lost
        • MCNPRunParameters.mcnp_card
        • MCNPRunParameters.messages
        • MCNPRunParameters.modes
        • MCNPRunParameters.nps
        • MCNPRunParameters.physics_particles
        • MCNPRunParameters.secondary_particle_biasing
        • MCNPRunParameters.stop_tallies
        • MCNPRunParameters.xsdir
      • MCNPTallyParameters
        • MCNPTallyParameters.cell_flags
        • MCNPTallyParameters.dose_interpolation
        • MCNPTallyParameters.multiplier
        • MCNPTallyParameters.surface_flags
        • MCNPTallyParameters.tally_divisor
    • mcio.decomposeparams
      • DecompositionParameters
        • DecompositionParameters.aux_bounding_box_analysis
        • DecompositionParameters.aux_generate
        • DecompositionParameters.aux_surface_cone_angle_tol
        • DecompositionParameters.aux_surface_cone_simple
        • DecompositionParameters.aux_surface_cone_small_angle
        • DecompositionParameters.aux_surface_cylinder_angle_tol
        • DecompositionParameters.aux_surface_cylinder_simple
        • DecompositionParameters.aux_surface_cylinder_small_angle
        • DecompositionParameters.aux_surface_face_distace_tol
        • DecompositionParameters.aux_surface_sphere_angle_tol
        • DecompositionParameters.aux_surface_sphere_simple
        • DecompositionParameters.aux_surface_sphere_small_angle
        • DecompositionParameters.aux_surface_tori_angle_tol
        • DecompositionParameters.aux_surface_tori_aux_surface_simple
        • DecompositionParameters.aux_surface_tori_small_angle
        • DecompositionParameters.bool_common_fuzzy_value
        • DecompositionParameters.bool_cutter_fuzzy_value
        • DecompositionParameters.bool_degenerate_min_ab_vol
        • DecompositionParameters.bool_degenerate_min_area_to_vol_ratio
        • DecompositionParameters.bool_degenerate_min_vol_fraction_of_original
        • DecompositionParameters.bool_splitter_fuzzy_value
        • DecompositionParameters.bounding_box_multiplier_half_space
        • DecompositionParameters.cleanup_inexact_edge_fix_tol_max
        • DecompositionParameters.cleanup_inexact_edge_fix_tol_min
        • DecompositionParameters.cleanup_inexact_edges
        • DecompositionParameters.cleanup_inexact_edges_tol
        • DecompositionParameters.cleanup_shape_fix
        • DecompositionParameters.cleanup_shape_fix_tol_max
        • DecompositionParameters.cleanup_shape_fix_tol_min
        • DecompositionParameters.cleanup_unify_same_domains
        • DecompositionParameters.debug_cad_output_verbosity
        • DecompositionParameters.debug_common_error_path
        • DecompositionParameters.debug_common_fatal_path
        • DecompositionParameters.debug_common_warning_path
        • DecompositionParameters.debug_concentric_splitter
        • DecompositionParameters.debug_cut_common_path
        • DecompositionParameters.debug_cut_error_path
        • DecompositionParameters.debug_cut_fatal_path
        • DecompositionParameters.debug_cut_warning_path
        • DecompositionParameters.debug_failed_to_convert_directory
        • DecompositionParameters.debug_filter_degenerate_solid_path
        • DecompositionParameters.debug_half_space_failed_to_generate_path
        • DecompositionParameters.debug_invalid_solid_path
        • DecompositionParameters.debug_large_number_of_split_solids
        • DecompositionParameters.debug_large_number_of_split_solids_directory
        • DecompositionParameters.debug_logger_verbosity
        • DecompositionParameters.debug_long_conversion_time
        • DecompositionParameters.debug_long_conversion_time_directory
        • DecompositionParameters.debug_pipe_splitter
        • DecompositionParameters.debug_rectilinear_splitter
        • DecompositionParameters.debug_save_solid
        • DecompositionParameters.debug_splitter_error_path
        • DecompositionParameters.debug_splitter_fatal_path
        • DecompositionParameters.debug_splitter_warning_path
        • DecompositionParameters.debug_trackback_directory
        • DecompositionParameters.debug_volume_conserved_path
        • DecompositionParameters.debug_write_added_solids
        • DecompositionParameters.doc_unit_in_metres
        • DecompositionParameters.doc_xcaf_formatting
        • DecompositionParameters.make_face_tol
        • DecompositionParameters.model_implicit_void_for_no_mateirals
        • DecompositionParameters.model_set_output_cell_vols
        • DecompositionParameters.other_nominal_gap
        • DecompositionParameters.presplit_about_axis
        • DecompositionParameters.presplit_about_axis_n_times
        • DecompositionParameters.presplit_concentril_2nd_order
        • DecompositionParameters.presplit_pipes
        • DecompositionParameters.presplit_pipes_cyl_angle_tol
        • DecompositionParameters.presplit_rectilinear_voxels
        • DecompositionParameters.presplit_rectilinear_voxels_width
        • DecompositionParameters.split_max_distnace_between_face_and_halfspace
        • DecompositionParameters.split_sew
        • DecompositionParameters.split_skip_non_cutting_planes
        • DecompositionParameters.split_skip_non_cutting_planes_rel_tol
        • DecompositionParameters.split_unify_same_domains
        • DecompositionParameters.surf_cone_axis_angle_tol
        • DecompositionParameters.surf_cone_axis_distance_tol
        • DecompositionParameters.surf_cone_rounding_lateral
        • DecompositionParameters.surf_cone_rounding_t_sq
        • DecompositionParameters.surf_cone_semi_angle_tol
        • DecompositionParameters.surf_cylinder_rounding_lateral
        • DecompositionParameters.surf_cylinder_rounding_radius
        • DecompositionParameters.surf_cylinder_tol_axis_angle
        • DecompositionParameters.surf_cylinder_tol_axis_distance
        • DecompositionParameters.surf_cylinder_tol_radius
        • DecompositionParameters.surf_general_quadratic_rounding_abc
        • DecompositionParameters.surf_general_quadratic_rounding_def
        • DecompositionParameters.surf_general_quadratic_rounding_ghj
        • DecompositionParameters.surf_general_quadratic_rounding_k
        • DecompositionParameters.surf_plane_rounding_lateral
        • DecompositionParameters.surf_plane_rounding_vector
        • DecompositionParameters.surf_plane_tol_distance
        • DecompositionParameters.surf_plane_tol_normal_angle
        • DecompositionParameters.surf_plane_tol_on_axis
        • DecompositionParameters.surf_sph_position_tol
        • DecompositionParameters.surf_sph_radius_tol
        • DecompositionParameters.surf_tol_tori_axis_angle
        • DecompositionParameters.surf_tol_tori_centre
        • DecompositionParameters.surf_tol_tori_major_radius
        • DecompositionParameters.surf_tol_tori_minor_radius
        • DecompositionParameters.surf_tori_rounding_lateral
        • DecompositionParameters.surf_tori_rounding_radii
        • DecompositionParameters.void_bounding_box_use_optimal
        • DecompositionParameters.void_face_distance_tol
        • DecompositionParameters.void_filter_by_face
        • DecompositionParameters.void_max_faces_per_octant
        • DecompositionParameters.void_max_recursion_depth
        • DecompositionParameters.void_max_split_solids_per_octant
        • DecompositionParameters.void_min_width
        • DecompositionParameters.void_split_solid_distance_tol
        • DecompositionParameters.void_split_solid_fractoin_of_bounding_box
        • DecompositionParameters.void_use_halfspace_pruning
        • DecompositionParameters.void_use_obb_check
        • DecompositionParameters.void_use_split_solid_distance_check
        • DecompositionParameters.wire_is_closed_tol
mcio
  • mcio documentation
  • View page source

mcio documentation

Welcome to the documentation for mcio. Use the navigation on the left to explore the user guide and API reference.

Menu

  • Installation
    • End user installation
    • Dev installation
    • OpenMC
    • Conda installation for CadQuery-OCP
  • User guide
    • 1. Building CSG models
    • 2. CAD-to-CSG decomposition
  • API Reference
    • mcio.surface
    • mcio.volume
    • mcio.material
    • mcio.tally
    • mcio.source
    • mcio.cell
    • mcio.model
    • mcio.mcnp
    • mcio.decomposeparams
Next

© Copyright 2026, UKAEA.

Built with Sphinx using a theme provided by Read the Docs.