Skip to content

Commit

Permalink
Remove existing deprecations from icepyx v1.x (#640)
Browse files Browse the repository at this point in the history
Co-authored-by: GitHub Action <asteiker@users.noreply.github.com>
  • Loading branch information
JessicaS11 and asteiker authored Feb 5, 2025
1 parent 07ff3c0 commit 60d21fc
Show file tree
Hide file tree
Showing 19 changed files with 448 additions and 719 deletions.
16 changes: 2 additions & 14 deletions doc/source/example_notebooks/IS2_DEM_comparison_WIP.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -137,15 +137,14 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## Finding and downloading data\n",
"In order to download any data from NSIDC, we must first authenticate ourselves using a valid Earthdata login (available for free on their website). This will create a valid token to interface with the DAAC as well as start an active logged-in session to enable data download. The token is attached to the data object and stored, but the session must be passed to the download function. Then we can order the granules."
"## Finding and downloading data"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Log in to Earthdata"
"### Search for Data"
]
},
{
Expand All @@ -169,17 +168,6 @@
"region_a.granules.avail"
]
},
{
"cell_type": "markdown",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Important Authentication Update\n",
"Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
15 changes: 2 additions & 13 deletions doc/source/example_notebooks/IS2_cloud_data_access.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -222,17 +222,6 @@
"# reg.s3login_credentials"
]
},
{
"cell_type": "markdown",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Important Authentication Update\n",
"Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down Expand Up @@ -370,7 +359,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"display_name": "icepyx",
"language": "python",
"name": "python3"
},
Expand All @@ -384,7 +373,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.10"
"version": "3.12.7"
}
},
"nbformat": 4,
Expand Down
13 changes: 1 addition & 12 deletions doc/source/example_notebooks/IS2_data_access.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -478,17 +478,6 @@
"- with stored credentials in a .netrc file (not recommended for security reasons)"
]
},
{
"cell_type": "markdown",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Important Authentication Update\n",
"Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials using one of the three methods described above.\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down Expand Up @@ -638,7 +627,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.10"
"version": "3.12.7"
}
},
"nbformat": 4,
Expand Down
26 changes: 0 additions & 26 deletions doc/source/example_notebooks/IS2_data_read-in.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -149,18 +149,6 @@
"region_a.download_granules(path=path_root)"
]
},
{
"cell_type": "markdown",
"id": "04f62f30-b13c-4cfc-95b0-dd1e048f6a85",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Important Authentication Update\n",
"Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "e8da42c1",
Expand Down Expand Up @@ -318,20 +306,6 @@
"ipx.Read(list_of_files)"
]
},
{
"cell_type": "markdown",
"id": "08df2874-7c54-4670-8f37-9135ea296ff5",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Read Module Update\n",
"Previously, icepyx required two additional conditions: 1) a `product` argument and 2) that your files either matched the default `filename_pattern` or that the user provided their own `filename_pattern`. These two requirements have been removed. `product` is now read directly from the file metadata (the root group's `short_name` attribute). Flexibility to specify multiple files via the `filename_pattern` has been replaced with the [glob string](https://docs.python.org/3/library/glob.html) feature, and by allowing a list of filepaths as an argument.\n",
"\n",
"The `product` and `filename_pattern` arguments are now deprecated and were removed in icepyx version 1.0.0.\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "4275b04c",
Expand Down
17 changes: 3 additions & 14 deletions doc/source/example_notebooks/IS2_data_variables.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -340,17 +340,6 @@
"# start_time='00:00:00', end_time='23:59:59')"
]
},
{
"cell_type": "markdown",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Important Authentication Update\n",
"Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {
Expand Down Expand Up @@ -1063,9 +1052,9 @@
],
"metadata": {
"kernelspec": {
"display_name": "icepyx-dev",
"display_name": "icepyx",
"language": "python",
"name": "icepyx-dev"
"name": "python3"
},
"language_info": {
"codemirror_mode": {
Expand All @@ -1077,7 +1066,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.11.4"
"version": "3.12.7"
}
},
"nbformat": 4,
Expand Down
12 changes: 0 additions & 12 deletions doc/source/example_notebooks/IS2_data_visualization.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -210,18 +210,6 @@
"region.download_granules(path)"
]
},
{
"cell_type": "markdown",
"id": "10cc8fef-7a43-41c4-ab22-6f551ad68659",
"metadata": {
"user_expressions": []
},
"source": [
"```{admonition} Important Authentication Update\n",
"Previously, icepyx required you to explicitly use the `.earthdata_login()` function to login. Running this function is deprecated and will result in an error, as icepyx will call the login function as needed. The user will still need to provide their credentials.\n",
"```"
]
},
{
"cell_type": "markdown",
"id": "textile-casting",
Expand Down
Loading

0 comments on commit 60d21fc

Please sign in to comment.