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 1.58 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
16
*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 or have a local copy do the following:

Qusai Al Shidi's avatar
Qusai Al Shidi committed
17
```bash
18
# Skip this if using it in SWMF directory.
19
$ git clone https://gitlab.umich.edu/swmf_sofware/swmfpy.git /path/to/my/dir
Qusai Al Shidi's avatar
Qusai Al Shidi committed
20
21
```

22
Then go to its directory and run [pip](https://pip.pypa.io/en/stable/) to install. Make sure to include `--user`.
23
24

```bash
25
26
$ cd SWMF/share/Python/swmfpy  # or your clone directory
$ pip install --user .
27
28
```

29
30
*Note*: Depending on your system [pip](https://pip.pypa.io/en/stable/) may be ran in several ways: `pip`, `pip3`, or `python3 -m pip`

31
Then import it into your python project. 
Qusai Al Shidi's avatar
Qusai Al Shidi committed
32
33
34
35
36

```python
import swmfpy
```

37
38
39
Documentation
-------------

40
41
42
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
43
44

```python
45
import swmfpy
Qusai Al Shidi's avatar
Qusai Al Shidi committed
46
47
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
48
```
Qusai Al Shidi's avatar
Autodoc    
Qusai Al Shidi committed
49

50
51
52
Issues
------

53
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.