README.markdown 1.48 KB
Newer Older
1
2
![swmfpy logo](share/logo/swmfpy.png "swmfpy")

Qusai Al Shidi's avatar
Qusai Al Shidi committed
3
4
swmfpy
======
Qusai Al Shidi's avatar
Qusai Al Shidi committed
5

6
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
7

8
This is a work in progress.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
9

10
11
Installation
------------
12
13

Clone into the directory you want to use it.
Qusai Al Shidi's avatar
Qusai Al Shidi committed
14

15
*Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy make a clone and work that way and make a merge request.
16

17
Install with [pip](https://pip.pypa.io/en/stable/):
18

19
```shell
Qusai Al Shidi's avatar
Qusai Al Shidi committed
20
21
$ python3 -m pip install --user wheel  # Might be necessary
$ python3 -m pip install --user git+https://gitlab.umich.edu/swmf_software/swmfpy.git@master
22
23
```

24
*Note*: Depending on your system [pip](https://pip.pypa.io/en/stable/) may be ran in other ways: `python3 -m pip` or `python -m pip`
25

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

```python
import swmfpy
```

32
33
34
Documentation
-------------

35
36
37
An auto-documented version can be found [here](DOCUMENTATION.markdown).

However, 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
38
39

```python
40
import swmfpy
Qusai Al Shidi's avatar
Qusai Al Shidi committed
41
42
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
43
```
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
44

45
46
47
Issues
------

48
If you are experiencing any issues or bugs please go to the [Issues](https://gitlab.umich.edu/swmf_software/swmfpy/issues) page and create an issue. Make sure you include steps to recreate the problem in your post.