A Python package for plotting the positions, directions or energy distributions of OpenMC sources.
Installation
You will need to have OpenMC version 0.14.0 or newer installed first.
pip install openmc_source_plotter
Features
The package provides three plotting functions that can plot source data from openmc objects.
plot_source_energyplot_source_positionplot_source_directionplot_gamma_emission
Additionally the package provides a convienient method of sampling particles
sample_initial_particles
Example plots
Below are some basic examples, for more examples see the examples folder for example usage scripts.
Plot of energy distribution of the source
🔗Link to example script.
Plot of energy distribution of two sources
🔗Link to example script.
Plot direction of particles
🔗Link to example script.
Plot position of particles
🔗Link to example script.
Plot labeled gamma lines from material
🔗Link to example script.
Extract particle objects
A list of openmc.Particle objects can be obtained using model.sample_initial_particles() or openmc.SourceBase.sample_initial_particles()
import openmc
from openmc_source_plotter import sample_initial_particles
settings = openmc.Settings()
settings.particles = 1
settings.batches = 1
my_source = openmc.IndependentSource()
my_source.energy = openmc.stats.muir(e0=14080000.0, m_rat=5.0, kt=20000.0)
settings.source = my_source
materials = openmc.Materials()
sph = openmc.Sphere(r=100, boundary_type="vacuum")
cell = openmc.Cell(region=-sph)
geometry = openmc.Geometry([cell])
model = openmc.Model(geometry, materials, settings)
particles = sample_initial_particles(this=model, n_samples=10)
print(particles)
>>>[<SourceParticle: neutron at E=1.440285e+07 eV>, <SourceParticle: neutron at E=1.397691e+07 eV>, <SourceParticle: neutron at E=1.393681e+07 eV>, <SourceParticle: neutron at E=1.470896e+07 eV>, <SourceParticle: neutron at E=1.460563e+07 eV>, <SourceParticle: neutron at E=1.420684e+07 eV>, <SourceParticle: neutron at E=1.413932e+07 eV>, <SourceParticle: neutron at E=1.412428e+07 eV>, <SourceParticle: neutron at E=1.464779e+07 eV>, <SourceParticle: neutron at E=1.391648e+07 eV>]
print(particles[0].E)
>>>1.440285e+07
Related packages
Tokamak sources can also be plotted using the openmc-plasma-source package
Metadata
Release files for openmc-source-plotter 0.7.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| openmc_source_plotter-0.7.2.tar.gz | 38.2 kB | Without provenance | Details for openmc_source_plotter-0.7.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| openmc_source_plotter-0.7.2-py3-none-any.whl | Python 3 | none | any | Details for openmc_source_plotter-0.7.2-py3-none-any.whl |
Total release size: 47.0 kB
Release files / openmc_source_plotter-0.7.2.tar.gz
| Download URL | openmc_source_plotter-0.7.2.tar.gz |
|---|---|
| Size | 38.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1889ae006bf7e034a9b0cad2292ecb92122ab8d612fbbe6d3f356b6a2ca91f3b
|
|
BLAKE2b-256 checksum How to use checksums |
297ffdd4ce50502f5410b210de7a97ddcf29f49221c007c927504b4da59dbe22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / openmc_source_plotter-0.7.2-py3-none-any.whl
| Download URL | openmc_source_plotter-0.7.2-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
177036a018d790ff4eaca2eb650973dbeab5252692195d2041f8c551bbdf7a8d
|
|
BLAKE2b-256 checksum How to use checksums |
638c8be84668ca843e75e3cdbaeb040ff76481dac94c904fda6fc71510fd2c2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Security for openmc-source-plotter 0.7.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.