Commit 6cbbc022 authored by Leonie Pick's avatar Leonie Pick

Update readme

parent b42021de
......@@ -20,7 +20,7 @@ If not, see http://www.gnu.org/licenses/.
### Citation
Pick, Leonie (2019): ClassifyStorms - an automatic classifier for geomagnetic storm drivers based on
Pick, Leonie (2019): ClassifyStorms - An automatic classifier for geomagnetic storm drivers based on
machine learning techniques. V. 1.0.0. GFZ Data Services. http://doi.org/10.5880/GFZ.2.3.2019.003
### What is ClassifyStorms?
......@@ -28,17 +28,17 @@ ClassifyStorms is a software package that performs a classification of geomagnet
mechanisms based exclusively on magnetometer measurements from ground.<br>
In the present version two such driver classes are considered. Class 0 holds storms driven by Corotating or Stream Interaction
Regions (C/SIRs) and Class 1 holds storms driven by Interplanetary Coronal Mass Ejections (ICMEs). The classification task is
executed by a supervised binary logistic regression model in the framework of python's scikit-learn.
executed by a supervised binary logistic regression model in the framework of python's scikit-learn library.
### How to run ClassifyStorms?
Download the GitLab project 'ClassifyStorms' from http://gitext.gfz-potsdam.de/lpick/ClassifyStorms/ by clicking on the 'Download'
button. Additionally, download 'Input.nc' from ftp://ftp.gfz-potsdam.de/home/mag/pick/ClassifyStorms/ and place it into
the extracted directory ClassifyStorms-master. Navigate to ClassifyStorms-master and start the jupyter server
(http://jupyter.org/) by typing 'jupyter notebook' into the command line. This will open the jupyter 'Home' in your web
Download the GitLab project 'ClassifyStorms' from http://gitext.gfz-potsdam.de/lpick/ClassifyStorms by clicking on the 'Download'
button (top right). Additionally, download 'Input.nc' from ftp://ftp.gfz-potsdam.de/home/mag/pick/ClassifyStorms and place it into
the extracted directory 'ClassifyStorms-master'. Navigate to ClassifyStorms-master and start the jupyter server
(http://jupyter.org) by typing 'jupyter notebook' into the command line. This will open the jupyter 'Home' in your web
browser. Select 'ClassifyStorms.ipynb' from the list and run the notebook by clicking 'Run'.
### Get involved!
+ Fork the GitLab project 'ClassifyStorms' from http://gitext.gfz-potsdam.de/lpick/ClassifyStorms by clicking on the 'Fork' button.
+ Fork the GitLab project 'ClassifyStorms' from http://gitext.gfz-potsdam.de/lpick/ClassifyStorms by clicking on the 'Fork' button (top right).
+ Clone the forked project to a local directory.
+ Create a new development branch and apply your changes to it.
+ Commit your changes and push them to your forked project at GitLab. If you are done, merge the development branch into the master branch.
......
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