README.markdown 939 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

Usage
-----

Gabor Toth's avatar
Gabor Toth committed
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
```

Gabor Toth's avatar
Gabor Toth committed
17
Set the PYTHONPATH environment variable to include this directory. Then import it into your python project. 
Qusai Al Shidi's avatar
Qusai Al Shidi committed
18
19
20
21
22

```python
import swmfpy
```

23
24
25
26
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
27
28

```python
29
import swmfpy
Qusai Al Shidi's avatar
Qusai Al Shidi committed
30
31
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
32
```
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
33
34

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