Added documentation, changelog and a few more things, tagging this as well

CHANGELOG.markdown

@@ -5,15 +5,24 @@ Changelog:
 Contributors:
 -------------
 
-   131	Qusai Al Shidi
+   137	Qusai Al Shidi
      2	Camilla D. K. Harris
-     1	Gabor Toth
+     2	Gabor Toth
+     1	Camilla Dodge Koslowsky Harris
      1	TKeebler
 
 Changes:
 --------
 
-- 05ac345 **(2020-06-19, Qusai Al Shidi)**: _C:HEAD -> master, origin/master, origin/HEAD:_ merged amendment :s
+- 23c6e26 **(2020-08-05, Gabor Toth)**: _C:HEAD -> carrington_rotation:_ Carrington Rotation function added and sunpy dependency removed
+- 8e18ac8 **(2020-08-04, Qusai Al Shidi)**: _C:origin/master, origin/HEAD, master:_ Fixed LaTeX citation string
+- 8211554 **(2020-08-04, Qusai Al Shidi)**: _C::_ Fixed install swmfpy line
+- f1724e7 **(2020-08-04, Qusai Al Shidi)**: _C::_ Added instructions for python venv and also snippets to contributing page.
+- d0a8308 **(2020-07-06, Qusai Al Shidi)**: _C:pybatstools:_ Fixed up `CONTRIBUTING.markdown` to be better and added issues guidelines
+- 9549026 **(2020-07-06, Qusai Al Shidi)**: _C::_ Should be `shell` and not `bash` for markdown language alias
+- 178dd8e **(2020-06-22, Qusai Al Shidi)**: _C::_ Merge branch 'tecplot-doc-update' into 'master'
+- facad25 **(2020-06-22, Camilla Dodge Koslowsky Harris)**: _C::_ Tecplot documentation update
+- 05ac345 **(2020-06-19, Qusai Al Shidi)**: _C::_ merged amendment :s
 - 8d04c39 **(2020-06-19, Qusai Al Shidi)**: _C::_ optional requires `tecplot`
 - 3e676fa **(2020-06-19, Qusai Al Shidi)**: _C::_ optional requires `tecplot`
 - 991a3a2 **(2020-06-19, Qusai Al Shidi)**: _C:tag: v2020.5:_ v2020.5 commit

DOCUMENTATION.markdown

@@ -15,6 +15,7 @@
   * [replace\_command](#.swmfpy.paramin.replace_command)
   * [read\_command](#.swmfpy.paramin.read_command)
 * [swmfpy.tools](#.swmfpy.tools)
+  * [carrington\_rotation\_number](#.swmfpy.tools.carrington_rotation_number)
 * [swmfpy.tecplottools](#.swmfpy.tecplottools)
   * [apply\_equations](#.swmfpy.tecplottools.apply_equations)
 
@@ -157,13 +158,6 @@ Downloads HMI vector magnetogram fits files.
 This will download vector magnetogram FITS files from
 Joint Science Operations Center (JSOC) near a certain hour.
 
-This unfortunately depends on sunpy and drms, if you don't have it try,
-
-
-```bash
-pip install -U --user sunpy drms
-```
-
 **Arguments**:
 
 - `mag_time` _datetime.datetime_ - Time after which to find
@@ -506,6 +500,25 @@ values for the parameters.
 Tools to be used in swmfpy functions and classes. Some of the functions are
 *hidden functions*.
 
+<a name=".swmfpy.tools.carrington_rotation_number"></a>
+#### carrington\_rotation\_number
+
+```python
+carrington_rotation_number(the_time='now')
+```
+
+Returns the carrington rotation
+
+**Arguments**:
+
+- `the_time` _datetime.datetime/str_ - The time to convert to carrington
+  rotation.
+  
+
+**Returns**:
+
+- `(int)` - Carrington Rotation
+
 <a name=".swmfpy.tecplottools"></a>
 ## swmfpy.tecplottools
 

swmfpy/tools.py

@@ -9,6 +9,15 @@ import datetime as dt
 
 
 def carrington_rotation_number(the_time='now'):
+    """Returns the carrington rotation
+
+    Args:
+        the_time (datetime.datetime/str): The time to convert to carrington
+                                          rotation.
+
+    Returns:
+        (int): Carrington Rotation
+    """
     if the_time == 'now':
         return carrington_rotation_number(dt.datetime.now())
     if isinstance(the_time, str):

swmfpy/web.py

@@ -267,12 +267,6 @@ def download_magnetogram_hmi(mag_time, hmi_map='hmi.B_720s', **kwargs):
     This will download vector magnetogram FITS files from
     Joint Science Operations Center (JSOC) near a certain hour.
 
-    This unfortunately depends on sunpy and drms, if you don't have it try,
-
-    ```bash
-    pip install -U --user sunpy drms
-    ```
-
     Args:
         mag_time (datetime.datetime): Time after which to find
                                       vector magnetograms.