Skip to content

A Python library that downloads data from the Applied Climate Information System (ACIS) Database, performs various types of analyses on the data and makes various types of graphical summaries of the data.

License

Notifications You must be signed in to change notification settings

edrewitz/xmACIS2Py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

image image

Conda Version PyPI - Version Conda Recipe

Anaconda Downloads:

Conda Downloads

PIP Downloads:

PyPI - Downloads

xmACIS2Py

ANNOUNCEMENT: xmACIS2Py < 2.0 is now depreciated and replaced with xmACIS2Py >= 2.0

xmACIS2Py 2.0 Documentation and Jupyter Lab Tutorial

xmACIS2Py < 2.0 (Legacy) Documentation and Jupyter Lab Tutorials Jupyter Lab Tutorials

  1. In this example we will make 30 and 90-day temperature and precipitation summaries for KRAL - click here
  2. In this example we will use a custom date range (via changing the optional arguments) and make a temperature and precipitation graphic for PASN (This also is an example with missing data!") - click here
  3. In this example we will remove the running mean from a temperature summary (via changing the optional arguments) for KJFK - click here
  4. In this example we will add the running sum to a precipitation summary graphic (via changing the optional arguments) for KRAL - click here
  5. In this example we will plot the maximum temperature summary for KLAX - click here
  6. In this example we will plot the minimum temperature summary for KONT - click here
  7. In this example we will plot the average temperature summary for KSTC - click here
  8. In this example we will plot the average temperature departure summary for KSTC - click here
  9. In this example we will plot the heating degree days summary for KRAL - click here
  10. In this example we will plot the cooling degree days summary for KBRO - click here
  11. In this example we will plot the growing degree days summary for KBRO - click here

Documentation

plot_temperature_summary(station, product_type)

This function plots a graphic showing the Temperature Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means will be hidden

plot_precipitation_summary(station, product_type)

This function plots a graphic showing the Precipitation Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_sum (Boolean) - Default = False. When set to True, running sums will be shown

plot_maximum_temperature_summary(station, product_type)

This function plots a graphic showing the Maximum Temperature Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means will be hidden

plot_minimum_temperature_summary(station, product_type)

This function plots a graphic showing the Minimum Temperature Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means will be hidden

plot_average_temperature_summary(station, product_type)

This function plots a graphic showing the Average Temperature Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means will be hidden

plot_average_temperature_departure_summary(station, product_type)

This function plots a graphic showing the Average Temperature Departure Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means will be hidden

plot_hdd_summary(station, product_type)

This function plots a graphic showing the Heating Degree Days Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means and sums will be hidden

plot_cdd_summary(station, product_type)

This function plots a graphic showing the Cooling Degree Days Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means and sums will be hidden

plot_gdd_summary(station, product_type)

This function plots a graphic showing the Growing Degree Days Summary for a given station for a given time period.

Required Arguments:

  1. station (String) - The identifier of the ACIS2 station.

  2. product_type (String or Integer) - The type of product. 'Past 7 Days' as a string or enter 7 for the same result. A value of 'custom' or 'Custom' will result in the user entering a custom start/stop date.

Optional Arguments:

  1. start_date (String) - Default=None. Enter the start date as a string (i.e. 01-01-2025)

  2. end_date (String) - Default=None. Enter the end date as a string (i.e. 01-01-2025)

  3. show_running_mean (Boolean) - Default = True. When set to False, running means and sums will be hidden

References

  1. xmACIS2: https://www.rcc-acis.org/docs_webservices.html

  2. MetPy: May, R. M., Goebbert, K. H., Thielen, J. E., Leeman, J. R., Camron, M. D., Bruick, Z., Bruning, E. C., Manser, R. P., Arms, S. C., and Marsh, P. T., 2022: MetPy: A Meteorological Python Library for Data Analysis and Visualization. Bull. Amer. Meteor. Soc., 103, E2273-E2284, https://doi.org/10.1175/BAMS-D-21-0125.1.

  3. NumPy: Harris, C.R., Millman, K.J., van der Walt, S.J. et al. Array programming with NumPy. Nature 585, 357–362 (2020). DOI: 10.1038/s41586-020-2649-2. (Publisher link).

  4. Pandas: Pandas: McKinney, W., & others. (2010). Data structures for statistical computing in python. In Proceedings of the 9th Python in Science Conference (Vol. 445, pp. 51–56).

  5. WxData: Eric J. Drewitz. (2025). edrewitz/WxData: WxData 1.1.4 Released (WxData1.1.4). Zenodo. https://doi.org/10.5281/zenodo.17862030

About

A Python library that downloads data from the Applied Climate Information System (ACIS) Database, performs various types of analyses on the data and makes various types of graphical summaries of the data.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages