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

Fixed Documentation # characters

parent 6d36af13
......@@ -51,6 +51,7 @@ period.
- `time_from` _datetime.datetime_ - Time to begin omni data retrieval
- `time_to` _datetime.datetime_ - Time to end omni data retrieval
- `filename` _str_ - The filename for the dat file, defaults to 'IMF.dat'.
**kwargs:
see `swmfpy.io.write_imf_input()` and `swmfpy.web.get_omni_data()`
......@@ -412,7 +413,7 @@ Note, if you have repeat commands this will replace all the repeats.
**Arguments**:
- `parameters` _dict_ - Dictionary of strs with format
replace = '\#COMMAND': ['value', 'comments', ...]
replace = '#COMMAND': ['value', 'comments', ...]
This is case sensitive.
- `input_file` _str_ - String of PARAM.in file name.
- `output_file` _str_ - (default 'PARAM.in') The output file to write to.
......@@ -431,7 +432,7 @@ Note, if you have repeat commands this will replace all the repeats.
**Examples**:
```python
change['\#SOLARWINDFILE'] = [['T', 'UseSolarWindFile'],
change['#SOLARWINDFILE'] = [['T', 'UseSolarWindFile'],
['new_imf.dat', 'NameSolarWindFile']]
# This will overwrite PARAM.in
swmfpy.paramin.replace('PARAM.in.template', change)
......@@ -446,12 +447,12 @@ read_command(command, paramin_file='PARAM.in', **kwargs)
Get parameters of a certain command in PARAM.in file.
This will find the \#COMMAND and return a list of
This will find the #COMMAND and return a list of
values for the parameters.
**Arguments**:
- `command` _str_ - This is the \#COMMAND you're looking for.
- `command` _str_ - This is the #COMMAND you're looking for.
- `paramin_file` _str_ - (default: 'PARAM.in') The file in which you're
looking for the command values.
**kwargs:
......@@ -461,20 +462,20 @@ values for the parameters.
**Returns**:
- `list` - Values found for the \#COMMAND in file. Index 0 is
\#COMMAND and the values follow (1 for first argument...)
- `list` - Values found for the #COMMAND in file. Index 0 is
#COMMAND and the values follow (1 for first argument...)
**Raises**:
- `ValueError` - When the \#COMMAND is not found.
- `ValueError` - When the #COMMAND is not found.
**Examples**:
```python
start_time = swmfpy.paramin.read_command('\#STARTTIME')
end_time = swmfpy.paramin.read_command('\#ENDTIME')
start_time = swmfpy.paramin.read_command('#STARTTIME')
end_time = swmfpy.paramin.read_command('#ENDTIME')
print('Starting month is ', start_time[1])
print('Ending month is ', end_time[1])
```
......
......@@ -4,5 +4,5 @@
# run `pip install pydoc-markdown --user`
# then run this script in the project root directory
pydoc-markdown --py3 -v -I. --render-toc -m swmfpy -m swmfpy.web -m swmfpy.io -m swmfpy.paramin -m swmfpy.tools | sed 's/\\043/#/g' - > DOCUMENTATION.markdown
pydoc-markdown --py3 -v -I. --render-toc -m swmfpy -m swmfpy.web -m swmfpy.io -m swmfpy.paramin -m swmfpy.tools $@ | sed 's/\\043/#/g' - > DOCUMENTATION.markdown
......@@ -37,8 +37,9 @@ def write_imf_from_omni(time_from, time_to, filename='IMF.dat', **kwargs):
time_from (datetime.datetime): Time to begin omni data retrieval
time_to (datetime.datetime): Time to end omni data retrieval
filename (str): The filename for the dat file, defaults to 'IMF.dat'.
**kwargs:
see #swmfpy.io.write_imf_input() and #swmfpy.web.get_omni_data()
**kwargs:
see #swmfpy.io.write_imf_input() and #swmfpy.web.get_omni_data()
Examples:
Using this function is simple:
......
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