Step 01 : Install and test Anaconda
===================================

Anaconda
--------
Anaconda is a Python distribution for scientist. 
It contains every popular packages used for science purpose and works with both Python 2 and 3.

You can download Anaconda here (we recommend using python 2.7) :
https://www.continuum.io/downloads

Then you are only some clicks away from having it installed on your computer. 
Just follow the few instructions of the web page (download script/installer and run it).
There are instructions for Windows (32 or 64), Linux and Mac OS X. 

You do not need to have Python pre-installed. Anaconda installer/scripts will install everything for you.

Jupyter Notebook
----------------

The Jupyter Notebook is a web application that allows you to create 
and share documents that contain live code, equations, visualizations 
and explanatory text. Uses include: data cleaning and transformation, 
numerical simulation, statistical modeling, machine learning and much more.

If you have installed Anaconda then Jupyter is **already ready for use**.

The given Starting-kit is a Jupyter Notebook. You can run your Jupyter app by running in your terminal :
~~~
jupyter notebook
~~~

You should do it at the root directory of your RAMP workspace. It allows you to find 
the notebooks (*.ipynb files) more easily.

For Mac, you'll find a Navigator.app in the anoconda directory, which you can use to launch the notebook.



Miscellaneous
-------------

For your eyes convenience you can **optionally** install *seaborn* which makes prettier charts.
Run in a terminal:
~~~
pip install seaborn
~~~

or in a jupyter notebook code cell:
~~~
!pip install seaborn
~~~


Step 02 : Register and test the RAMP interface
==============================================

To submit your code you will have to register and upload it to the RAMP server.
Here is the address of the server : http://www.ramp.studio
First you should register, then wait for a mail confirmation.


Second log-in and you arrive on a web page with all the currently running RAMP.

Third you should register to the RAMP you want to participate.
Then wait for a mail confirmation.

To test the settings, we will use the *IRIS TEST RAMP* but it 
works the same with every RAMP. 

Once you have registered and received confirmation you can click on 
*sandbox* to access the code uploading part of the server.

![title](IMG/Sanbox.png)

Then copy-past your code in the text window.
![title](IMG/CopyPaste.png)

**You should be careful to include all the needed package used in your code**
~~~python
import package.subpackage
from package import my_function, SomeClass
~~~
** or the server will run it and return an error to you and you will have waited for nothing.
This is a very frequent mistake and this is why we provide a user_test_model.py script 
to test for common mistakes.**

Then choose a fun (or not) name for your model (will be used in the LeaderBoard).

![title](IMG/Naming.png)

Finally you can save your code (will be uploaded to the server)

![title](IMG/Save.png)

And submit it (will be run on the server)

![title](IMG/Submit.png)

After some time the server will give you the results on the LeaderBoard.

![title](IMG/Leaderboard.png)

Step 03 : Improve your model
============================

When you have correctly submitted one model you are ready to work on improving it.

You can read the submitted code of the other participant by clicking on it on the 
LeaderBoard. **And you should do it ! **

Check the models that work best to add their good features to yours. 
Check the models that do not work well to prevent you from exploring already tested ideas.

It is a cooperative work as much as a competition.

Share your ideas/results/problems with your team or your neighbors (or both).

Then submit your code again (same as step 02)!

Have fun !