Skip to content

Commit

Permalink
Update documentation on downloader.py
Browse files Browse the repository at this point in the history
  • Loading branch information
DahyannAraya committed Oct 28, 2024
1 parent 49dbae7 commit aa5bda3
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2,360 deletions.
9 changes: 5 additions & 4 deletions climada_petals/hazard/copernicus_forecast/downloader.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@
from climada.util.constants import SYSTEM_DIR

Check warning on line 5 in climada_petals/hazard/copernicus_forecast/downloader.py

View check run for this annotation

Jenkins - WCR / Pylint

unused-import

NORMAL: Unused SYSTEM_DIR imported from climada.util.constants
Raw output
Used when an imported module or variable is not used.

class Downloader:

Check warning on line 7 in climada_petals/hazard/copernicus_forecast/downloader.py

View check run for this annotation

Jenkins - WCR / Pylint

too-few-public-methods

LOW: Too few public methods (1/2)
Raw output
Used when class has too few public methods, so be sure it's really worth it.
"""A class to download data from the Copernicus Climate Data Store (CDS).
"""A class to download data from the Copernicus Data Stores, including cds.climate.copernicus.eu,

Check warning on line 8 in climada_petals/hazard/copernicus_forecast/downloader.py

View check run for this annotation

Jenkins - WCR / Pylint

line-too-long

LOW: Line too long (101/100)
Raw output
Used when a line is longer than a given number of characters.
ads.atmosphere.copernicus.eu and ewds.climate.copernicus.eu.
This downloader allows for retrieving various climate datasets from the CDS by specifying the
dataset type and required parameters.
This downloader allows for retrieving various climate datasets from the Copernicus Data Stores by

Check warning on line 11 in climada_petals/hazard/copernicus_forecast/downloader.py

View check run for this annotation

Jenkins - WCR / Pylint

line-too-long

LOW: Line too long (101/100)
Raw output
Used when a line is longer than a given number of characters.
specifying the dataset type and required parameters.
Attributes
----------
Expand All @@ -30,7 +31,7 @@ def __init__(self):

Check warning on line 31 in climada_petals/hazard/copernicus_forecast/downloader.py

View check run for this annotation

Jenkins - WCR / Pylint

trailing-whitespace

LOW: Trailing whitespace
Raw output
Used when there is whitespace between the end of a line and the newline.

def download_data(self, dataset_type, params, filename, overwrite=False):
"""Download data from CDS using specified dataset type and parameters.
"""Download data from Copernicus Data Stores using specified dataset type and parameters.
Parameters
----------
Expand Down
2,391 changes: 35 additions & 2,356 deletions doc/tutorial/climada_hazard_copernicus_forecast.ipynb

Large diffs are not rendered by default.

0 comments on commit aa5bda3

Please sign in to comment.