Skip to content

Commit 11c307d

Browse files
author
shimwell
committed
Merge branch 'python_version' of github.com:Shimwell/parametric-plasma-source into python_version
2 parents 69b1f7c + c4d0e38 commit 11c307d

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ The parametric plasma source can be imported an used in Python 3 in the followin
1414

1515
```
1616
from parametric_plasma_source import Plasma
17-
my_plasma = Plasma(major_radius=6, minor_radius=1.5)
17+
my_plasma = Plasma(major_radius=6,
18+
minor_radius=1.5,
19+
elongation = 2.0
20+
triangularity = 0.55)
1821
my_plasma.export_plasma_source('custom_openmc_plasma_source.so')
1922
```
2023

21-
In the above example the major_radius and minor radius are changed from the default.
24+
In the above example the major_radius, minor_radius, elongation and triangularity while the other varibles are kept as the default values.
2225

2326
There are a number of additional arguments that can be passed to the Plasma class on construction. Units are in SI (e.g. meters not cm)
2427

@@ -41,4 +44,4 @@ number_of_bins = 100
4144
plasma_type = 1
4245
```
4346

44-
For a better understanding of the varibles take a look at the [C. Fausser et al](https://www.sciencedirect.com/science/article/pii/S0920379612000853) paper.
47+
For a better understanding of the varibles take a look at the [C. Fausser et al](https://www.sciencedirect.com/science/article/pii/S0920379612000853) paper.

0 commit comments

Comments
 (0)