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.

Verified Commit f2c47aec authored by Qusai Al Shidi's avatar Qusai Al Shidi 💬
Browse files

MAINT: Doc update

parent d8770618
Pipeline #31969 passed with stage
in 3 minutes and 18 seconds
../../.gitlab/merge_request_templates/Merge Request
\ No newline at end of file
...@@ -21,7 +21,7 @@ If you fill out those you are ready to [submit an issue](https://gitlab.umich.ed ...@@ -21,7 +21,7 @@ If you fill out those you are ready to [submit an issue](https://gitlab.umich.ed
Contributing Code Contributing Code
================= =================
Before submitting pull requests please make sure your code complies with the following. Before submitting pull/merge requests please make sure your code complies with the following.
Git etiquette Git etiquette
------------- -------------
......
...@@ -3,27 +3,24 @@ ...@@ -3,27 +3,24 @@
swmfpy swmfpy
====== ======
A collection of tools to make it easier to work with Python and Space Weather Modeling Framework (SWMF) together. A library of tools to make it easier to work with Python and Space Weather Modeling Framework (SWMF) together.
This is a work in progress.
Installation Installation
------------ ------------
*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. *Note*: swmfpy also is part of the SWMF and gets cloned into `SWMF/share/Python` for bundling purposes only. However, if you would like to [develop](CONTRIBUTING.markdown) for swmfpy make a clone and work that way and make a merge request.
There are two methods of installing swmfpy with with a virtual environment and without a virtual environment. Only use the virtual environment if your current environment is giving you trouble. There are two *supported* methods of installing swmfpy with with a virtual environment and without a virtual environment. Only use the virtual environment if your current environment is giving you trouble.
### Without Python venv ### Without Python venv
Install with [pip](https://pip.pypa.io/en/stable/): Install with [pip](https://pip.pypa.io/en/stable/):
```shell ```bash
$ python3 -m pip install --user wheel # Might be necessary $ pip install swmfpy || python3 -m pip install swmfpy || python3 -m pip install --user swmfpy
$ python3 -m pip install --user git+https://gitlab.umich.edu/swmf_software/swmfpy.git@master
``` ```
*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` *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` or `pip`
Then import it into your python project. Then import it into your python project.
...@@ -55,7 +52,7 @@ Next install the software. This will take a long time as you will be compiling ` ...@@ -55,7 +52,7 @@ Next install the software. This will take a long time as you will be compiling `
$ source ~/.venv/bin/activate $ source ~/.venv/bin/activate
$ python3 -m pip install --user wheel -vvv $ python3 -m pip install --user wheel -vvv
$ python3 -m pip install --user cython -vvv $ python3 -m pip install --user cython -vvv
$ python3 -m pip install --user git+https://gitlab.umich.edu/swmf_software/swmfpy.git@master $ python3 -m pip install --user swmfpy -vvv
``` ```
If you are using `tmux` or `GNU Screen` on a supercomputer you can safely detach your session and power off your computer and come back another time. If you are using `tmux` or `GNU Screen` on a supercomputer you can safely detach your session and power off your computer and come back another time.
...@@ -68,14 +65,16 @@ import swmfpy ...@@ -68,14 +65,16 @@ import swmfpy
### Troubleshooting ### Troubleshooting
If you have followed these carefully and still not been able to install please submit an Issue. If you have followed these carefully and still not been able to install
please submit an Issue.
Documentation Documentation
------------- -------------
An auto-documented version can be found [here](DOCUMENTATION.markdown). 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. However, documentation is included as docstrings.
Use python's *dir()* and *help()* inbuilt functions to see documentation.
```python ```python
import swmfpy import swmfpy
...@@ -86,7 +85,9 @@ help(swmfpy.io.read_gm_log) # To see the function documentation ...@@ -86,7 +85,9 @@ help(swmfpy.io.read_gm_log) # To see the function documentation
Issues Issues
------ ------
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. If you are experiencing any issues or bugs please go to the Issues page on
[gitlab](https://gitlab.umich.edu/swmf_software/swmfpy/issues) or [github](https://github.com/MSTEM-QUDA/swmfpy/issues)
page and create an issue. Make sure you follow the templates.
How to cite How to cite
----------- -----------
......
...@@ -13,7 +13,7 @@ with open('requirements.txt') as fh_requirements: ...@@ -13,7 +13,7 @@ with open('requirements.txt') as fh_requirements:
setuptools.setup( setuptools.setup(
name='swmfpy', name='swmfpy',
version='2020.10', version='2020.11',
author='Qusai Al Shidi', author='Qusai Al Shidi',
author_email='qusai@umich.edu', author_email='qusai@umich.edu',
description='''A collection of tools for the Space Weather Modelling description='''A collection of tools for the Space Weather Modelling
......
...@@ -20,7 +20,7 @@ These must be imported manually. ...@@ -20,7 +20,7 @@ These must be imported manually.
""" """
__author__ = 'Qusai Al Shidi' __author__ = 'Qusai Al Shidi'
__license__ = 'LGPLv3' __license__ = 'LGPLv3'
__version__ = '2020.10' __version__ = '2020.11'
__maintainer__ = 'Qusai Al Shidi' __maintainer__ = 'Qusai Al Shidi'
__email__ = 'qusai@umich.edu' __email__ = 'qusai@umich.edu'
__credits__ = 'University of Michigan, Climate and Space Sciences & Engineering' __credits__ = 'University of Michigan, Climate and Space Sciences & Engineering'
......
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