Skip to content

Commit a0f7953

Browse files
albavilanovaalbavilanova
authored
Merge pull request #191 from esowc/branch-alba
Enhance args explanation
2 parents ae1e9d5 + e1a03a2 commit a0f7953

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

‎functions/functions_cams.ipynb‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@
6868
" model_level (str): Model levels:\n",
6969
" - 'Simple' for total columns\n",
7070
" - 'Multiple' for levels\n",
71-
" CAMS_UID (str): ADS user ID\n",
72-
" CAMS_key (str): ADS key\n",
71+
" CAMS_UID (str): User ID in ADS platform\n",
72+
" CAMS_key (str): User API key in ADS platform\n",
7373
"\n",
7474
" Returns:\n",
7575
" CAMS_product_name (str): Product name of CAMS product\n",
@@ -256,7 +256,7 @@
256256
" dates (arr): Query dates\n",
257257
" \n",
258258
" Returns:\n",
259-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
259+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
260260
" \"\"\"\n",
261261
"\n",
262262
" # Read as xarray dataset object\n",
@@ -331,7 +331,7 @@
331331
" \"\"\" Create table with information about the CAMS model levels\n",
332332
"\n",
333333
" Args:\n",
334-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
334+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
335335
" CAMS_product_name (str): Product name of CAMS product\n",
336336
" \n",
337337
" Returns:\n",
@@ -378,7 +378,7 @@
378378
" https://confluence.ecmwf.int/display/OIFS/4.4+OpenIFS%3A+Vertical+Resolution+and+Configurations\n",
379379
"\n",
380380
" Args:\n",
381-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
381+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
382382
" CAMS_product_name (str): Product name of CAMS product\n",
383383
" CAMS_levels_df (dataframe): Table with 137 CAMS levels data\n",
384384
" start_date (str): Query start date\n",
@@ -389,11 +389,11 @@
389389
" lon_min (int): Minimum longitude\n",
390390
" lon_max (int): Maximum longitude\n",
391391
" area_name (str): User defined area name\n",
392-
" CAMS_UID (str): ADS user ID\n",
393-
" CAMS_key (str): ADS key\n",
392+
" CAMS_UID (str): User ID in ADS platform\n",
393+
" CAMS_key (str): User API key in ADS platform\n",
394394
" \n",
395395
" Returns:\n",
396-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
396+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
397397
" \"\"\"\n",
398398
" \n",
399399
" CAMS_pressure_product_name = ('_SURFACE_PRESSURE_' + start_date + '_' + end_date +\n",
@@ -521,7 +521,7 @@
521521
" \"\"\" Get the tropospheric or column model data, depending on the nature of the sensor data\n",
522522
"\n",
523523
" Args:\n",
524-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
524+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
525525
" CAMS_product_name (str): Product name of CAMS product\n",
526526
" CAMS_levels_df (dataframe): Table with 137 CAMS levels data\n",
527527
" column_type (str): Tropospheric or total column\n",
@@ -531,7 +531,7 @@
531531
" lon_max (int): Maximum longitude\n",
532532
" \n",
533533
" Returns:\n",
534-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
534+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
535535
" \"\"\"\n",
536536
"\n",
537537
" # Get units and calculate tropospheric columns if needed\n",
@@ -581,18 +581,18 @@
581581
" calculate columns above each CAMS half level assuming it is 0 at the top of the atmosphere\n",
582582
"\n",
583583
" Args:\n",
584-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
584+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
585585
" CAMS_levels_df (dataframe): Table with 137 CAMS levels data\n",
586586
" sensor (str): Name of the sensor\n",
587587
" start_date (str): Query start date\n",
588588
" end_date (str): Query end date\n",
589589
" component_nom (str): Component chemical nomenclature\n",
590590
" apply_kernels (bool): Apply (True) or not (False) the averaging kernels\n",
591-
" CAMS_UID (str): ADS user ID\n",
592-
" CAMS_key (str): ADS key\n",
591+
" CAMS_UID (str): User ID in ADS platform\n",
592+
" CAMS_key (str): User API key in ADS platform\n",
593593
" \n",
594594
" Returns:\n",
595-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
595+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
596596
" \"\"\"\n",
597597
"\n",
598598
" # Calculate columns above each CAMS half level \n",
@@ -667,11 +667,11 @@
667667
" \"\"\" Convert the units of the CAMS dataset for any component from kg/m2 to molecules/cm2\n",
668668
"\n",
669669
" Args:\n",
670-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
670+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
671671
" component_MW (float): Component molecular weight\n",
672672
"\n",
673673
" Returns:\n",
674-
" CAMS_ds (xarray): CAMS levels dataset in xarray format\n",
674+
" CAMS_ds (xarray): Model dataset in xarray format (CAMS)\n",
675675
" \"\"\"\n",
676676
"\n",
677677
" # Convert units from kg/m2 to molecules/cm2\n",

‎functions/functions_general.ipynb‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@
399399
" *args: satellites, lat_res, lon_res\n",
400400
"\n",
401401
" Returns:\n",
402-
" sensor_ds (xarray): sensor dataset in xarray format\n",
402+
" sensor_ds (xarray): Sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
403403
" support_input_ds (xarray): TROPOMI dataset that contains support input data in xarray format\n",
404404
" support_details_ds (xarray): TROPOMI dataset that contains support details data in xarray format\n",
405405
" \"\"\" \n",
@@ -445,12 +445,12 @@
445445
" \"\"\" Convert the units of the sensor dataset for any component from mol/m2 to molecules/cm2\n",
446446
"\n",
447447
" Args:\n",
448-
" sensor_ds (xarray): sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
448+
" sensor_ds (xarray): Sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
449449
" sensor (str): Name of the sensor\n",
450450
" component_nom (str): Component chemical nomenclature\n",
451451
" \n",
452452
" Returns:\n",
453-
" sensor_ds (xarray): sensor dataset in xarray format\n",
453+
" sensor_ds (xarray): Sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
454454
" \"\"\"\n",
455455
"\n",
456456
" if sensor == 'tropomi':\n",
@@ -502,7 +502,7 @@
502502
"\n",
503503
" Args:\n",
504504
" model (str): Name of the model\n",
505-
" model_ds (xarray): model dataset in xarray format (CAMS)\n",
505+
" model_ds (xarray): Model dataset in xarray format (CAMS)\n",
506506
" sensor (str): Name of the sensor\n",
507507
" component_MW (float): Component molecular weight\n",
508508
" model_levels_df (dataframe): Table with 137 CAMS levels data\n",
@@ -514,7 +514,7 @@
514514
" CAMS_key (str): ADS key\n",
515515
" \n",
516516
" Returns:\n",
517-
" model_ds (xarray): model dataset in xarray format\n",
517+
" model_ds (xarray): Model dataset in xarray format (CAMS)\n",
518518
" \"\"\"\n",
519519
"\n",
520520
" if model == 'cams':\n",
@@ -757,8 +757,8 @@
757757
" the averaging kernels are applied if possible\n",
758758
"\n",
759759
" Args:\n",
760-
" sensor_ds (xarray): sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
761-
" model_ds (xarray): model dataset in xarray format (CAMS)\n",
760+
" sensor_ds (xarray): Sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
761+
" model_ds (xarray): Model dataset in xarray format (CAMS)\n",
762762
" bbox (arr): Query bounding box\n",
763763
" sensor (str): Name of the sensor\n",
764764
" component_nom (str): Component chemical nomenclature\n",
@@ -880,8 +880,8 @@
880880
"\n",
881881
" Args:\n",
882882
" match_df (dataframe): Intermediate merge table with total column or partial column from both datasets\n",
883-
" sensor_ds (xarray): sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
884-
" model_ds (xarray): model dataset in xarray format (CAMS)\n",
883+
" sensor_ds (xarray): Sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
884+
" model_ds (xarray): Model dataset in xarray format (CAMS)\n",
885885
" apply_kernels (bool): Apply (True) or not (False) the averaging kernels\n",
886886
" sensor (str): Name of the sensor\n",
887887
" \n",
@@ -950,7 +950,7 @@
950950
" \"\"\" Define plot period\n",
951951
"\n",
952952
" Args:\n",
953-
" sensor_ds (xarray): sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
953+
" sensor_ds (xarray): Sensor dataset in xarray format (TROPOMI, IASI or GOME-2)\n",
954954
" sensor_type (str): Sensor type\n",
955955
"\n",
956956
" Returns:\n",

0 commit comments

Comments
 (0)