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 6f8cbfc1 authored by Qusai Al Shidi's avatar Qusai Al Shidi
Browse files

Updated readme to reflect the new state of swmfpy in SWMF installation

parent 9141aa9c
......@@ -8,7 +8,9 @@ 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`)
*Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python`. If you ran `Config.pl -install` while installing SWMF you probably already have it installed in your Python distribution. If you have already done this it is installed on your system. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy or have a local copy continue reading.
Clone into the directory you want to use it.
```bash
git clone https://gitlab.umich.edu/swmf_sofware/swmfpy.git /path/to/my/dir
......@@ -18,6 +20,7 @@ Then go to its directory and run `setup.py` make sure to include `--user`.
```bash
cd /path/to/swmfpy
python3 -m pip install setuptools wheel twine --user # If you don't have these
python3 setup.py install --user
```
......@@ -40,7 +43,9 @@ 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).
*Note*: The autodoc tool has troubles escaping the `#` symbol so examples with `#COMMAND`s in `PARAM.in` files will not show the symbol. Perhaps I can find a fix but the `help()` pages are always better and up to date.
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.
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.
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