Merge pull request #109 from fusion-energy/docs-update

Updated ICF docs
fusion-energy · Nov 27, 2024 · f727423 · f727423
2 parents e0777ac + 4ff350a
commit f727423
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git 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
@@ -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.