README.markdown 386 Bytes
Newer Older
Qusai Al Shidi's avatar
Qusai Al Shidi committed
1
2
swmfpy
======
Qusai Al Shidi's avatar
Qusai Al Shidi committed
3

4
A collection of tools to make it easier to work with python and SWMF together.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
5

6
This is a work in progress.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
7
8
9
10
11
12

Usage
-----

Clone into the directory you want to use it.

Qusai Al Shidi's avatar
Qusai Al Shidi committed
13
```bash
Qusai Al Shidi's avatar
Qusai Al Shidi committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
git clone https://gitlab.umich.edu/qusai/swmfpy.git
```

Then import it into your python project.

```python
import swmfpy
```

Documentation is included.

```python
help(swmfpy.read_gm_log)
```