Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated ICF docs #109

Merged
merged 1 commit into from
Nov 27, 2024
Merged

Updated ICF docs #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "openmc_plasma_source"
dynamic = ["version"]
description = "Creates tokamak and ICF plasma sources for OpenMC"
description = "Creates tokamak and fusion point sources for OpenMC"
readme = "README.md"
classifiers = [
"Programming Language :: Python :: 3",
Expand Down
7 changes: 4 additions & 3 deletions src/openmc_plasma_source/point_source.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ def fusion_point_source(
temperature: float = 20000.0,
fuel: Dict[str, float] = {"D": 0.5, "T": 0.5},
) -> List[IndependentSource]:
"""Creates a list of openmc.IndependentSource objects representing an ICF source.
"""
Creates a list of openmc.IndependentSource objects representing a point source.
Example uses: sealed-tube neutron generator, inertial confinement fusion source...
Resulting ICF (Inertial Confinement Fusion) source will have an energy
distribution according to the fuel composition.
Resulting source will have an energy distribution according to the fuel composition.
Args:
coordinate: Location of the point source.
Expand Down
Loading