Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

README.markdown 532 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 Space Weather Modeling Framework (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
14
git clone https://gitlab.umich.edu/qusai/swmfpy.git /path/to/my/dir
Qusai Al Shidi's avatar
Qusai Al Shidi committed
15
16
17
18
19
20
21
22
23
24
25
```

Then import it into your python project.

```python
import swmfpy
```

Documentation is included.

```python
26
import swmfpy
Qusai Al Shidi's avatar
Qusai Al Shidi committed
27
28
help(swmfpy)  # To see list of functions
help(swmfpy.io.read_gm_log)  # To see the function documentation
Qusai Al Shidi's avatar
Qusai Al Shidi committed
29
```