example directory restructured

[aeroaks]

Regarding #95

• Converting the .py scripts in examples to Jupyter notebooks
• Remove the old examples/examples-notebook directory and the .py scripts in examples
• Make sure these work from mybinder by adding a command to install PyFME

[codecov-io]

Current coverage is 87.25% (diff: 100%)

Merging #100 into master will not change coverage

@@             master       #100   diff @@
==========================================
  Files            28         28          
  Lines          1914       1914          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1670       1670          
  Misses          244        244          
  Partials          0          0          

Powered by Codecov. Last update 5fe3d5a...435bc10

[aqreed]

@aeroaks I would like to keep the .py examples files, as they will be needed to simulate and tests new developments. Also, not everyone uses notebooks (I don't, for example), so what I propose is to keep the .ipynb files in the old directory.

[astrojuanlu]

@aqreed We agreed the other day not to duplicate the examples - it's true that we need tests, but those should be unit tests. Keeping two versions of the examples is a mess, I'm -1 on keeping the .py files.

[aeroaks]

@aqreed I have not used it but I think that there is a way in which you can convert notebook file to scripts.
https://nbconvert.readthedocs.io/en/latest/

[aqreed]

@Juanlu001 well I do think py examples and nb examples should be two separate entities, Jupyter notebooks are a good thing but we should not impose its use neither to visitors or to developers.

[miqlar]

I am +1 to having both notebooks and .py's.

Notebooks are nice but annoying for fast checks and copypastes.

[astrojuanlu]

Pending review:

• Check links in index.ipynb
• Check that the notebooks match the scripts (perhaps using jupyter nbconvert Example.ipynb --to python)
• Check that the notebooks contain all output and plots

Who wants to review the pull request based on these bullet points? You can check out the changes using these commands:

git checkout -b aeroaks-master master
git pull git://github.com/aeroaks/PyFME.git master

[aqreed]

When doing jupyter nbconvert Example.ipynb --to python this line is added that crashes when executing the script: get_ipython().magic('matplotlib inline')...after deleting it the script runs fine.

@aeroaks I will send you a pull request with the modifications get all the plots in the examples 006 and 007 (my bad, I forgot to uncomment some of them in the previous PR). Also, example 005 was left executed too so I cleaned it up.

[astrojuanlu]

When doing jupyter nbconvert Example.ipynb --to python this line is added that crashes when executing the script: get_ipython().magic('matplotlib inline')...after deleting it the script runs fine.

You have to run your script with ipython:

$ ipython example.py

Then get_ipython will be already in global context.

(Source: http://stackoverflow.com/a/32539282/554319)

[astrojuanlu]

By the way, it seems like the conversion template con be modified, in case it's interesting:

http://nbconvert.readthedocs.io/en/latest/customizing.html

This is the default one:

https://github.com/jupyter/nbconvert/blob/master/nbconvert/templates/python.tpl

[AlexS12]

I have merged the branch so now can have both options at the same time. Nevertheless, as I see that @aqreed seems has more changes to do, we can discuss them in a new pull request