README.markdown 1.17 KB
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

Usage
-----

11
Clone into the directory you want to use it (swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`)
Qusai Al Shidi's avatar
Qusai Al Shidi committed
12

Qusai Al Shidi's avatar
Qusai Al Shidi committed
13
```bash
Gabor Toth's avatar
Gabor Toth committed
14
git clone https://gitlab.umich.edu/swmf_sofware/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
Then go to its directory and run `setup.py` make sure to include `--user`.

```bash
cd /path/to/swmfpy
python3 setup.py install --user
```

Then import it into your python project. 
Qusai Al Shidi's avatar
Qusai Al Shidi committed
25
26
27
28
29

```python
import swmfpy
```

30
31
32
33
Documentation
-------------

Documentation is included as docstrings. Use python's *dir()* and *help()* inbuilt functions to see documentation.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
34
35

```python
36
import swmfpy
Qusai Al Shidi's avatar
Qusai Al Shidi committed
37
38
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
39
```
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
40
41

However if you would like an auto-documented version (uses exact same text as the help() function output), go [here](DOCUMENTATION.markdown).
42
43
44
45
46

Issues
------

If you are experiencing any issues or bugs please go to the [Issues](issues) page and create an issue. Make sure you include steps to recreate the problem in your post.