Skip to content

Commit a869142

Browse files
committed
Add status badge
Also a few format update to README.
1 parent aa4a9da commit a869142

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# parametric-plasma-source
22

3+
![Python package](https://github.com/DanShort12/parametric-plasma-source/workflows/Python%20package/badge.svg)
4+
35
Python package, C++ source and build files for parametric plasma source for use in fusion neutron transport calculations with OpenMC.
46

57
The plasma source is based on a paper by [C. Fausser et al](https://www.sciencedirect.com/science/article/pii/S0920379612000853)
68

7-
# Installation
9+
## Installation
810

911
```pip install parametric_plasma_source```
1012

11-
# Usage
13+
## Usage
1214

1315
The parametric plasma source can be imported an used in Python 3 in the following manner.
1416

15-
```
17+
```[python]
1618
from parametric_plasma_source import Plasma
1719
my_plasma = Plasma(major_radius=6,
1820
minor_radius=1.5,
@@ -25,7 +27,7 @@ In the above example the major_radius, minor_radius, elongation and triangularit
2527

2628
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)
2729

28-
```
30+
```[python]
2931
ion_density_pedistal = 1.09e+20
3032
ion_density_seperatrix = 3e+19
3133
ion_density_origin = 1.09e+20

0 commit comments

Comments
 (0)