Creating of example folder structure

[Fonotec]

As discussed in the previous issue it would be excellent if we had an example structure in our code. Therefore I propose this merge request. Which starts by adding six basic examples, the examples will be automatically downloaded either from our CAMRAS server or from the charon CAMRAS server, after this the examples are run, currently none of the examples work yet.

[ewoudwempe]

Looks good :) Can you update the yml a bit? (things that are relevant: false and true instead of 0 for boolean inputs such as RawData or ConvertRaw, renaming Centrefreq to MixFreq, better chisq parameters, and metadata subdictionary, see the new param.yml).
But before merging this, perhaps we should probably add the features first :)

[ewoudwempe]

Zo werkt de code niet meer als hij vanaf een andere map wordt gerund. Kun je dat even fixen? Gewoon dirname van de python-file zelf opvragen in python. Iets als Path(__file__).parent+'/small-data-files/pulsarcat.csv', en from pathlib import Path bovenin importeren.

[ewoudwempe]

Of trouwens Path(__file__).parent/'small-data-files/pulsarcat.csv' is nog mooier :)

[Fonotec]

Okay, ik zal er even naar kijken, dat is wel een goede suggestie. Mooiste is natuurlijk als het programma vanuit alle folders gerunt kan worden, het zelfde geldt dan voor het defaults.yml bestand.

[Fonotec]

Okay, Currently I have 3 working examples. These are the huispulsar, buurpulsar and the buurpulsar_raw. For the other 3 examples with data we need to read a filterbank file and do the chifit. So I think this so far is all the working examples. Maybe we should get better data for the buurpulsar_raw, so that might be worth discussing Monday. And having a huispulsar_raw example would be really nice, so far I couldn't find a file like this on the data server. So do you think we can merge this branch with master?

[ewoudwempe]

Nice, I forgot about the defaults.yml, good catch. Huispulsar_raw is in fact possible, this observation is quite nice: http://www.astro.rug.nl/~camras/data/obs-18-11-2016/B0329%2054.2016.11.18.1038.5min.dat
It would be cleanest to not have non-working examples in master, but I guess the pulsar_live stuff is also in master and not completely working.

[ewoudwempe]

Also, this is quite a nice 'buurpulsar' one:
http://www.astro.rug.nl/~camras/data/obs-10-04-2018/B2016+28_10-04-2018-withP.fits.gz
The corresponding raw file:
http://www.astro.rug.nl/~camras/data/obs-10-04-2018/B2016-28_10-04-2018.dat

[Fonotec]

Okay, I improved the examples for the buurpulsar_raw and the huispulsar_raw, I currently get a bug when I run the huispulsar_raw which is kind of strange. When I run the example I get the error: ValueError: Input values did not match any of the formats where the format keyword is optional ['datetime', 'iso', 'isot', 'yday', 'fits', 'byear_str', 'jyear_str'] while, so far as I can see I included a readible date for astropy. I tend to agree with you on that we should only have working examples in the example folder, so lets first fix that we can also read filterbank such that we have something like 6 examples.

[ewoudwempe]

I don't think it is necessary to dynamically download these dependencies, instead, just copy them into our repository. They are small enough. Also, I think it is better to open a new pull request for the filterbank stuff, since it does not depend on this one.

[Fonotec]

Okay, I just removed the whole thing of dynamically downloading them. Instead I use the blimpy module, which is almost identical to what Tammo-Jan does, only this can be installed easily by pip.

[ewoudwempe]

This request has now been split up into #11, #12 and #13, so it will be closed.