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

Documentation fixes

parent dffef34f
...@@ -113,7 +113,7 @@ pip install -U --user drms ...@@ -113,7 +113,7 @@ pip install -U --user drms
**Returns**: **Returns**:
(str) list of filenames downloaded. - `str` - list of filenames downloaded.
**Raises**: **Raises**:
...@@ -221,12 +221,9 @@ text file into a dictionary of lists. ...@@ -221,12 +221,9 @@ text file into a dictionary of lists.
**Returns**: **Returns**:
- `dict` - Auroral indeces 'AL', 'AE', 'AO', 'AU'
- `dict` - { - `datetime.datetime` - 'times'
Auroral indeces 'AL', 'AE', 'AO', 'AU' (int): { - `int` - 'values'
'times' (datetime.datetime)
- `'values'` _int_ - List of indeces.
}
<a name=".swmfpy.io.read_wdc_asy_sym"></a> <a name=".swmfpy.io.read_wdc_asy_sym"></a>
#### read\_wdc\_asy\_sym #### read\_wdc\_asy\_sym
...@@ -248,8 +245,7 @@ and puts it into a dictionary. ...@@ -248,8 +245,7 @@ and puts it into a dictionary.
**Returns**: **Returns**:
- `dict` - of values. - `dict` - of values. {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
- `{'[ASY-SYM]-[D-H]'` - 'times': [], 'values': []}
**Examples**: **Examples**:
...@@ -290,7 +286,7 @@ from the GM model log. ...@@ -290,7 +286,7 @@ from the GM model log.
**Returns**: **Returns**:
Dictionary of the log file - `dict` - Dictionary of the log file
**Examples**: **Examples**:
......
...@@ -17,12 +17,9 @@ def read_wdc_ae(wdc_filename): ...@@ -17,12 +17,9 @@ def read_wdc_ae(wdc_filename):
wdc_filename (str): Filename of wdc data from wdc_filename (str): Filename of wdc data from
http://wdc.kugi.kyoto-u.ac.jp/ http://wdc.kugi.kyoto-u.ac.jp/
Returns: Returns:
dict: Auroral indeces 'AL', 'AE', 'AO', 'AU'
dict: { datetime.datetime: 'times'
Auroral indeces 'AL', 'AE', 'AO', 'AU' (int): { int: 'values'
'times' (datetime.datetime)
'values' (int): List of indeces.
}
""" """
# Initialize return data # Initialize return data
...@@ -71,8 +68,7 @@ def read_wdc_asy_sym(wdc_filename): ...@@ -71,8 +68,7 @@ def read_wdc_asy_sym(wdc_filename):
wdc_filename (str): Relative filename (or file handle no.) to read. wdc_filename (str): Relative filename (or file handle no.) to read.
Returns: Returns:
dict: of values. dict: of values. {'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
{'[ASY-SYM]-[D-H]': 'times': [], 'values': []}
Examples: Examples:
```python ```python
...@@ -169,7 +165,7 @@ def read_gm_log(filename, colnames=None, dtypes=None, index_time=True): ...@@ -169,7 +165,7 @@ def read_gm_log(filename, colnames=None, dtypes=None, index_time=True):
in dictionary key 'Time [UT]'. in dictionary key 'Time [UT]'.
Returns: Returns:
Dictionary of the log file dict: Dictionary of the log file
Examples: Examples:
To plot AL and Dst get the log files To plot AL and Dst get the log files
......
...@@ -163,7 +163,7 @@ def download_magnetogram_hmi(mag_time, **kwargs): ...@@ -163,7 +163,7 @@ def download_magnetogram_hmi(mag_time, **kwargs):
verbose (bool): (default False) print out the files it's downloading. verbose (bool): (default False) print out the files it's downloading.
Returns: Returns:
(str) list of filenames downloaded. str: list of filenames downloaded.
Raises: Raises:
ImportError: If module `drms` is not found. ImportError: If module `drms` is not found.
......
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