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.

Commit 6ab869c4 authored by Qusai Al Shidi's avatar Qusai Al Shidi
Browse files

Added tests directory but no tests yet. setup.py added to ensure it can be installed

parent 37d5b4f3
......@@ -8,13 +8,20 @@ This is a work in progress.
Usage
-----
Clone into the directory you want to use it (swmfpy also is part of the SWMF and gets cloned into SWMF/share/Python)
Clone into the directory you want to use it (swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`)
```bash
git clone https://gitlab.umich.edu/swmf_sofware/swmfpy.git /path/to/my/dir
```
Set the PYTHONPATH environment variable to include this directory. Then import it into your python project.
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.
```python
import swmfpy
......@@ -32,3 +39,8 @@ help(swmfpy.io.read_gm_log) # To see the function documentation
```
However if you would like an auto-documented version (uses exact same text as the help() function output), go [here](DOCUMENTATION.markdown).
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.
......@@ -17,11 +17,11 @@ These are not automatically imported. Might have extra dependancies.
*None yet.*
"""
__author__ = "Qusai Al Shidi"
__license__ = "MIT"
__version__ = "0.0.1"
__maintainer__ = "Qusai Al Shidi"
__email__ = "qusai@umich.edu"
__author__ = 'Qusai Al Shidi'
__license__ = 'MIT'
__version__ = '2020.0'
__maintainer__ = 'Qusai Al Shidi'
__email__ = 'qusai@umich.edu'
from . import paramin
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment