diff --git a/.gitignore b/.gitignore index 25b256cd..ecfbc008 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,20 @@ # ignore egginfo file ulmo.egg-info/ -# ignore build, dist dir +# ignore build, dist, ulmo_test_cache, .pytest_cache dir dist/ build/ +ulmo_test_cache/ +.pytest_cache/ # ignore sphinx build dir docs/_build/ # ignore compiled python files -*.pyc - -# Ignore checkpoints created (especially for the examples) +*.pyc + +# ignore .coverage +.coverage + +# Ignore checkpoints created (especially for the examples) .ipynb_checkpoints \ No newline at end of file diff --git a/docs/api.rst b/docs/api.rst index 2ad9470b..1a561729 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -9,7 +9,7 @@ ulmo readers / api's. .. _dates-and-times: note on dates and times ------------------------ +======================= Dates and times can provided a few different ways, depending on what is convenient. They can either be a string representation or as instances of date @@ -20,89 +20,53 @@ is accepted, as well dates in 'mm/dd/YYYY' format. .. _api: -California Department of Water Resources Historical Data -======================================================== -.. automodule:: ulmo.cdec.historical - :members: get_stations, get_sensors, get_station_sensors, get_data +Readers for Global to USA-national data +======================================= Climate Prediction Center (CPC) Weekly Drought -============================================== +---------------------------------------------- .. automodule:: ulmo.cpc.drought :members: get_data CUAHSI Hydrologic Information System (HIS) -========================================== +------------------------------------------ -CUAHSI HIS Central ------------------- .. automodule:: ulmo.cuahsi.his_central :members: get_services - -CUAHSI WaterOneFlow -------------------- .. automodule:: ulmo.cuahsi.wof :members: get_sites, get_site_info, get_values, get_variable_info -Lower Colorado River Authority (LCRA) -===================================== - -LCRA Hydromet Data ------------------- -.. automodule:: ulmo.lcra.hydromet - :members: get_sites_by_type, get_site_data, get_all_sites, get_current_data - - -LCRA Water Quality Data ------------------------ -.. automodule:: ulmo.lcra.waterquality - :members: get_sites, get_historical_data, get_recent_data, get_site_info - - NASA ORNL Daymet weather data services -====================================== +-------------------------------------- .. automodule:: ulmo.nasa.daymet :members: get_variables, get_daymet_singlepixel - + National Climatic Data Center (NCDC) -==================================== +------------------------------------ NCDC Climate Index Reference Sequential (CIRS) ------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: ulmo.ncdc.cirs :members: get_data - NCDC Global Historical Climate Network (GHCN) Daily ---------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: ulmo.ncdc.ghcn_daily :members: get_data, get_stations - NCDC Global Summary of the Day (GSoD) -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. automodule:: ulmo.ncdc.gsod :members: get_data, get_stations -Texas Weather Connection Daily Keetch-Byram Drought Index (KBDI) -================================================================ -.. automodule:: ulmo.twc.kbdi - :members: get_data - - -US Army Corps of Engineers - Tulsa District Water Control -========================================================= -.. automodule:: ulmo.usace.swtwc - :members: get_stations, get_station_data - - USGS National Water Information System (NWIS) -============================================= +--------------------------------------------- .. automodule:: ulmo.usgs.nwis :members: get_sites, get_site_data @@ -111,12 +75,43 @@ USGS National Water Information System (NWIS) USGS Emergency Data Distribution Network (EDDN) services -======================================================== +-------------------------------------------------------- .. automodule:: ulmo.usgs.eddn :members: get_data, decode -USGS National Elevation Dataset (NED) services -======================================================== +USGS National Elevation Dataset (NED) raster services +----------------------------------------------------- .. automodule:: ulmo.usgs.ned :members: get_available_layers, get_raster, get_raster_availability + + +Readers for USA regional (sub-national) data +============================================ + +California Department of Water Resources Historical Data +-------------------------------------------------------- +.. automodule:: ulmo.cdec.historical + :members: get_stations, get_sensors, get_station_sensors, get_data + + +Lower Colorado River Authority (LCRA) +------------------------------------- + +.. automodule:: ulmo.lcra.hydromet + :members: get_sites_by_type, get_site_data, get_all_sites, get_current_data + +.. automodule:: ulmo.lcra.waterquality + :members: get_sites, get_historical_data, get_recent_data, get_site_info + + +Texas Weather Connection Daily Keetch-Byram Drought Index (KBDI) +---------------------------------------------------------------- +.. automodule:: ulmo.twc.kbdi + :members: get_data + + +US Army Corps of Engineers - Tulsa District Water Control +--------------------------------------------------------- +.. automodule:: ulmo.usace.swtwc + :members: get_stations, get_station_data diff --git a/docs/index.rst b/docs/index.rst index a4e392ca..f5c3a230 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -52,7 +52,7 @@ API Reference Documentation for ulmo readers. .. toctree:: - :maxdepth: 2 + :maxdepth: 3 api