Added get_timeseries to preparation.py and unit test to test_preparation.py

[iglesias-cardinale]

Linting

• All parts of the code I added pass pylint. I also cleaned up preparation.py so that it scores a 10/10. there's a lot going on in test_preparation.py that I don't understand, so I cleaned it up a little bit but didn't mess with it too much since I don't want to delete something useful for somebody.

Contents

preparation.py

• Added get_timeseries(path)

  Takes input of path to json file. Returns pandas time series with the index being a datetime object and the data being the concentration of CO2 / methane. Assumes that the json file has the same format as mauna-loa-data/flask_monthly.json.

  test_preparation.py

• Added unit test to make sure the output timeseries has the same length (# of data points) as the input json file.

Reviewer

• It might make sense for @avgagliardo or @haiderabbas007 to review this as they collected the data.

This is the first time I've changed a file that somebody else created, but I think it all works. I'm doing my PR a little early in the hopes that I can fix any problems before class tomorrow. Let me know what I can improve, thanks!

[haiderabbas007]

I can review this

[haiderabbas007]

Here are a few comments:

1) The docstring for get_timeseries(path) is comprehensive and provides a good overview of the function's purpose and output. However, it can be slightly misleading since the plotting code is not part of the function itself. You might want to remove the plotting example from the docstring or clearly indicate that the plotting part is for demonstration and is not included in the function.

2) Indexing was creating an error.

3) After fixing indexing, there was an AttributeError.

4) After fixing both, the code worked and a plot was produced.

5) However, the plot has a flat portion from 1971 to 1975. Upon inspecting the raw file, I found that the data for these 5 years was missing. It would be appropriate to start from 1976 I think? @laserlab

6) The module-level docstring mentions fft, inverse fft, and calculate frequencies functions but none of these are in the code.

7) For your test_preparation.py file, The functions calc_freq, inv_fft, and fft are referenced in comments, but they are not defined in either the test script or preparation.py.

[laserlab]

5. However, the plot has a flat portion from 1971 to 1975. Upon inspecting the raw file, I found that the data for these 5 years was missing. It would be appropriate to start from 1976 I think? @laserlab

@haiderabbas007 Yes exactly, since this is your data collection task please open a new PR with the corrected data file

[laserlab]

@haiderabbas007 good review, but please use the review function and approve so it can get merged and you can get homework points. @SchrodingersStruggle Otherwise just merge it so we can go on

[haiderabbas007]

5. However, the plot has a flat portion from 1971 to 1975. Upon inspecting the raw file, I found that the data for these 5 years was missing. It would be appropriate to start from 1976 I think? @laserlab

@haiderabbas007 Yes exactly, since this is your data collection task please open a new PR with the corrected data file

Done

[haiderabbas007]

@haiderabbas007 good review, but please use the review function and approve so it can get merged and you can get homework points. @SchrodingersStruggle Otherwise just merge it so we can go on

Done

[iglesias-cardinale]

Thank you for the review. I'll make the changes you mentioned.

[iglesias-cardinale]

I was unsure how to go about documenting the potential use of the function, so I added the example in the docstring. I agree that it could be confusing, but before looking into this I wasn't familiar with plotting using pandas so I thought the example might be useful to have. I'll remove it before class today.