Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Discovery changes for V2.0.0 #737

Merged
merged 3 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,3 @@ omit =
versioneer.py
setup.py
act/plotting/histogramdisplay.py
act/discovery/get_arm.py
act/discovery/arm.py
act/discovery/airnow.py
act/discovery/asos.py
act/discovery/cropscape.py
act/discovery/neon.py
act/discovery/noaapsl.py
act/discovery/surfrad.py
12 changes: 12 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,18 @@ the tools documentation for details on this process.
- https://flake8.pycqa.org/en/latest/
- https://www.pylint.org/

Naming Convenction
----------------------------------------

Discovery
~~~~~~~~~
When adding discovery modules or functions please adhere to the following
* Filenames should just include the name of the organization (arm) or portal (airnow) and no other filler words like get or download
* Functions should follow [get/download]_[org/portal]_[data/other description]. If it is getting data but not downloading a file, it should start with get, like get_asos_data. If it downloads a file, it should start with download. The other description can vary depending on what you are retrieving. Please check out the existing functions for ideas.

Discovery
~~~~~~~~~
Similarly, for the io modules, the names should not have filler and just be the organization or portal name. The functions should clearly indicate what it is doing like read_arm_netcdf instead of read_netcdf if the function is specific to ARM files.

Adding Secrets and Environment Variables
----------------------------------------
Expand Down
17 changes: 8 additions & 9 deletions act/discovery/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@

__getattr__, __dir__, __all__ = lazy.attach(
__name__,
submodules=['get_armfiles', 'get_cropscape', 'get_airnow', 'get_noaapsl', 'get_neon', 'get_surfrad'],
submodules=['arm', 'cropscape', 'airnow', 'noaapsl', 'neon', 'surfrad'],
submod_attrs={
'get_arm': ['download_arm_data'],
'get_armfiles': ['download_data', 'download_arm_data', 'get_arm_doi'],
'get_asos': ['get_asos'],
'get_airnow': ['get_airnow_bounded_obs', 'get_airnow_obs', 'get_airnow_forecast'],
'get_cropscape': ['croptype'],
'get_noaapsl': ['download_noaa_psl_data'],
'get_neon': ['get_site_products', 'get_product_avail', 'download_neon_data'],
'get_surfrad': ['download_surfrad']
'arm': ['download_arm_data', 'get_arm_doi'],
'asos': ['get_asos_data'],
'airnow': ['get_airnow_bounded_obs', 'get_airnow_obs', 'get_airnow_forecast'],
'cropscape': ['get_crop_type'],
'noaapsl': ['download_noaa_psl_data'],
'neon': ['get_neon_site_products', 'get_neon_product_avail', 'download_neon_data'],
'surfrad': ['download_surfrad_data']
},
)
261 changes: 0 additions & 261 deletions act/discovery/get_airnow.py

This file was deleted.

Loading
Loading