From 4ff350ad3b63926e5ec9fe028a3c4e57d31a71de Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Wed, 27 Nov 2024 09:24:11 -0500 Subject: [PATCH] updated ICF docs --- pyproject.toml | 2 +- src/openmc_plasma_source/point_source.py | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 024466b..be9b6ee 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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", diff --git a/src/openmc_plasma_source/point_source.py b/src/openmc_plasma_source/point_source.py index e41ea11..9eeeaa8 100644 --- a/src/openmc_plasma_source/point_source.py +++ b/src/openmc_plasma_source/point_source.py @@ -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.