Add / Update docstrings for all scripts in final pipeline

[aranas]

According to docs/pipeline.md in branch:documentation commit 89b70a5 this is the list of files & functions that need to be included in the documentation I will draft docstrings for each function and will ask you to review (we might also want to check that variable naming is consistent)

• [x] ceda_ftp_download.py
  • [x] _downloadftp
• [x] resampling_hads.py
  • [x] _resamplehadukgrid
• [ ] reproject_all.sh, see also #30
  • [ ] _reprojectone.sh
• [ ] Cropping_Rasters_to_three_cities.R
  • [ ] _cpm_readcrop
  • [ ] _hads_readcrop
  • [ ] _hads_readcrop2
  • [ ] three_cities_debiasing.sh (three cities branch!)
  • [x] preprocess_data.py (three cities branch!)
    • [ ] _preprocessdata
    • [ ] _loaddata
  • [x] run_cmethods.py (three cities branch!)
    • [ ] _rundebiasing
  • [ ] apply_qmapQuant_to_crpd_df_fn.R
    • [ ] _apply_bias_correction_to_croppeddf
    • [ ] _apply_qmap_to_croppeddfL

Some of the script names above might relate to the LCAT pipeline or be outdated. @RuthBowyer to update this.

[aranas]

@RuthBowyer @gmingas Could you please check that these are all the files that we want to include in our documentation? There is a lot more going on in the repo (eg identify runs etc), but I am not sure which files relate to the pipeline, which ones are outdated and which ones are maybe not part of the pipeline but still worth sharing. Please point me to anything you'd like me to include :)

[gmingas]

@aranas I think this list is complete, I also added reproject_one.sh which might not be strictly necessary though.

[gmingas]

To be worked on along with the testing work @griff-rees is doing.

[gmingas]

As discussed yesterday, assigning @BZ-BowenZhang to this to work alongside @griff-rees , with @RuthBowyer support when needed, aiming to finish this by the next two-week milestone.

[gmingas]

@griff-rees has so far been using numpy format for docstrings. The same format should be used for all python code.

[griff-rees]

Here are some examples of numpydoc: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

I personally find the google style easier to write, but this seemed closest to the examples I found in the existing code base. In case you'd like to switch, google style examples: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

[andrewphilipsmith]

@griff-rees Please could you update the status of this issue following the merge of #122? Thank you