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

Variables as an independent class #451

Merged
merged 65 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
9d09ff9
mvp remove intake from Read
rwegener2 Aug 1, 2023
e5458a1
Merge branch 'development' into refactor_intake
rwegener2 Aug 29, 2023
24f6a42
delete is2cat and references
rwegener2 Aug 29, 2023
b13b847
remove extra comments
rwegener2 Aug 30, 2023
0779b80
update doc strings
rwegener2 Aug 30, 2023
1cfbf72
update tests
rwegener2 Aug 30, 2023
de61d87
update documentation for removing intake
rwegener2 Aug 30, 2023
9f06611
update approach paragraph
rwegener2 Aug 30, 2023
d019b9a
remove one more instance of catalog from the docs
rwegener2 Aug 30, 2023
156ea89
clear jupyter history
rwegener2 Aug 30, 2023
b26ca4e
Update icepyx/core/read.py
rwegener2 Sep 1, 2023
ce1ca76
remove intake and related modules
rwegener2 Sep 1, 2023
fd00aeb
Merge branch 'development' into read_arguments
rwegener2 Sep 4, 2023
431af78
mvp with new read parameters
rwegener2 Sep 5, 2023
612662e
clean up remainder of file and remove extraneous comments
rwegener2 Sep 5, 2023
c16a003
maintain backward compatibility and combine arguments
rwegener2 Sep 5, 2023
7648078
update to new error message
rwegener2 Sep 5, 2023
4cfbfdb
update docs
rwegener2 Sep 8, 2023
f7f823b
glob kwargs and list error
rwegener2 Sep 8, 2023
203f3ad
formatting updates
rwegener2 Sep 8, 2023
10d1591
Apply suggestions from code review
rwegener2 Sep 12, 2023
0b23d1e
remove num_files
rwegener2 Sep 12, 2023
6f5bead
fix docs test typo
rwegener2 Sep 12, 2023
035ee5a
trying again to fix the build
rwegener2 Sep 12, 2023
903c351
add feedback to docs page
rwegener2 Sep 12, 2023
d842bde
Merge branch 'development' into read_arguments
rwegener2 Sep 13, 2023
5e06de9
fix typo
rwegener2 Sep 14, 2023
9ca29f1
Merge branch 'development' into read_arguments
rwegener2 Sep 14, 2023
e8e35ad
Merge branch 'development' into read_arguments
rwegener2 Sep 18, 2023
e3566f8
mvp for making a standalone variables class
rwegener2 Sep 18, 2023
44fd8cc
clean comments
rwegener2 Oct 3, 2023
69dce54
split data_source into seperate arguments
rwegener2 Oct 16, 2023
72e1e37
clean dev notes
rwegener2 Oct 16, 2023
83d24fb
update docstrings
rwegener2 Oct 16, 2023
a187328
little fixes
rwegener2 Oct 17, 2023
dce23f9
upgrade Variables to an stand alone import
rwegener2 Oct 17, 2023
3561be8
update example notebooks
rwegener2 Oct 17, 2023
d13ac33
hide get_latest_version
rwegener2 Oct 17, 2023
593b9d1
update api docs
rwegener2 Oct 17, 2023
652a815
remove variables from components section
rwegener2 Oct 20, 2023
120694a
fix error dropping components
rwegener2 Oct 20, 2023
b4d59d6
move latest_version to is2ref
rwegener2 Oct 20, 2023
3f4bfa7
current status
rwegener2 Oct 23, 2023
a29e756
mvp updated read class
rwegener2 Oct 23, 2023
3f3cb1f
Merge branch 'development' into indep_vars
rwegener2 Oct 23, 2023
4f8e95a
add error message if no vars.wanted
rwegener2 Oct 26, 2023
d0838c8
update query class to append required vars
rwegener2 Oct 26, 2023
8127dbf
remove local filepaths
rwegener2 Oct 27, 2023
b3341c1
clean extraneous comments
rwegener2 Oct 27, 2023
a184d9c
Merge branch 'development' into indep_vars
rwegener2 Oct 27, 2023
8ff1e70
Update icepyx/core/query.py
rwegener2 Oct 31, 2023
3217565
remove redundant lines
rwegener2 Oct 31, 2023
c0e5f4e
Merge branch 'development' into indep_vars
rwegener2 Oct 31, 2023
defc76f
respond to review
rwegener2 Oct 31, 2023
5de9173
Merge branch 'indep_vars' of https://github.com/icesat2py/icepyx into…
rwegener2 Oct 31, 2023
c6dffe8
remove duplicate extract_product method
rwegener2 Nov 2, 2023
24751e9
add check for ATL14 data in extract product and version
rwegener2 Nov 2, 2023
b552808
add reference to latest_version
rwegener2 Nov 2, 2023
37bcc96
skip appending required vars for ATL14, 15, and 23
rwegener2 Nov 2, 2023
afbec98
clean logic for appending Coverage variables
rwegener2 Nov 2, 2023
5f7fc0a
Merge branch 'development' into indep_vars
rwegener2 Nov 2, 2023
9c4005a
spelling
rwegener2 Nov 3, 2023
607ce65
GitHub action UML generation auto-update
JessicaS11 Nov 6, 2023
170bd98
Add example
rwegener2 Nov 6, 2023
ef26223
move function to hopefully trigger a travis run
JessicaS11 Nov 6, 2023
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
42 changes: 30 additions & 12 deletions doc/source/example_notebooks/IS2_data_access2-subsetting.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"Create a query object and log in to Earthdata\n",
"\n",
Expand Down Expand Up @@ -83,7 +85,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"## Discover Subsetting Options\n",
"\n",
Expand All @@ -108,7 +112,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"By default, spatial and temporal subsetting based on your initial inputs is applied to your order unless you specify `subset=False` to `order_granules()` or `download_granules()` (which calls `order_granules` under the hood if you have not already placed your order) functions.\n",
"Additional subsetting options must be specified as keyword arguments to the order/download functions.\n",
Expand All @@ -118,7 +124,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"### _Why do I have to provide spatial bounds to icepyx even if I don't use them to subset my data order?_\n",
"\n",
Expand All @@ -132,7 +140,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"## About Data Variables in a query object\n",
"\n",
Expand All @@ -145,7 +155,9 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"### Determine what variables are available for your data product\n",
"There are multiple ways to get a complete list of available variables.\n",
Expand All @@ -159,23 +171,29 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"metadata": {
"tags": []
},
"outputs": [],
"source": [
"region_a.order_vars.avail()"
]
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"user_expressions": []
},
"source": [
"By passing the boolean `options=True` to the `avail` method, you can obtain lists of unique possible variable inputs (var_list inputs) and path subdirectory inputs (keyword_list and beam_list inputs) for your data product. These can be helpful for building your wanted variable list."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"metadata": {
"tags": []
},
"outputs": [],
"source": [
"region_a.order_vars.avail(options=True)"
Expand Down Expand Up @@ -353,9 +371,9 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": "icepyx-dev",
"language": "python",
"name": "python3"
"name": "icepyx-dev"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -367,7 +385,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.12"
"version": "3.11.4"
}
},
"nbformat": 4,
Expand Down
Loading