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

Changed contributing to include metadata directions

parent fd26dd4c
...@@ -17,6 +17,29 @@ Coding Standard ...@@ -17,6 +17,29 @@ Coding Standard
Please write readable code. Make sure your function names well describes your functions. Always include docstrings that use the [Google coding style](http://google.github.io/styleguide/pyguide.html#381-docstrings). The Google coding style guide is a good document to follow so I recommend reading it. Please write readable code. Make sure your function names well describes your functions. Always include docstrings that use the [Google coding style](http://google.github.io/styleguide/pyguide.html#381-docstrings). The Google coding style guide is a good document to follow so I recommend reading it.
Metadata
--------
Include metadata if you made a new function or module. Name and email will suffice. For example:
mynewpackage.py:
```python
"""A new package for swmfpy
"""
__name__ = "Rita Hayworth"
__email__ = "rita@umich.edu"
```
Or for a function:
```python
def my_new_func(some_args):
# my docstring
__name__ = "Diane Selwyn"
__email__ = "diane@umich.edu"
# function body
```
Dependencies Dependencies
------------ ------------
......
...@@ -45,22 +45,24 @@ def read_omni_csv(filename, filtering=False, **kwargs): ...@@ -45,22 +45,24 @@ def read_omni_csv(filename, filtering=False, **kwargs):
and turn it into a pandas.DataFrame. and turn it into a pandas.DataFrame.
Args: Args:
fnames: dict with filenames from omni .lst files. The keys must be: fnames (dict): dict with filenames from omni .lst files.
density, temperature, magnetic_field, velocity The keys must be: density, temperature,
filtering: default=False Remove points where the value magnetic_field, velocity
filtering (bool): default=False Remove points where the value
is >sigma (default: sigma=3) from mean. is >sigma (default: sigma=3) from mean.
**kwargs:
coarseness (int): default=3, Number of standard deviations
above which to remove if filtering=True.
clean (bool): default=True, Clean the omni data of bad data points
Returns: pandas.DataFrame object with solar wind data Returns:
pandas.DataFrame: object with solar wind data
Make sure to download the csv files with cdaweb.sci.gsfc.nasa.gov Make sure to download the csv files with cdaweb.sci.gsfc.nasa.gov
the header seperated into a json file for safety. the header seperated into a json file for safety.
This only tested with OMNI data specifically. This only tested with OMNI data specifically.
Other Args:
coarseness: default=3, Number of standard deviations above which to
remove if filtering=True.
clean: default=True, Clean the omni data of bad data points
""" """
# Read the csv files and set the index to dates # Read the csv files and set the index to dates
......
Supports Markdown
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