From a2dd4527206f84d88e67a8579d1391ec7d3bbe2f Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 24 Jun 2024 09:55:51 -0600 Subject: [PATCH 01/20] Add new pre-commit hooks from official repo https://github.com/pre-commit/pre-commit-hooks/ --- .pre-commit-config.yaml | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 68202d5c..6625eda9 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,10 +7,25 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 hooks: + # Validate format - id: check-yaml - - id: trailing-whitespace - id: check-toml - id: check-json + # Check for common mistakes + - id: check-added-large-files + - id: check-case-conflict + # - id: check-illegal-windows-names # TODO: Enable in next release + - id: check-merge-conflict + - id: check-executables-have-shebangs + - id: check-shebang-scripts-are-executable + - id: check-symlinks + - id: check-vcs-permalinks + - id: destroyed-symlinks + - id: detect-private-key + - id: end-of-file-fixer + - id: mixed-line-ending + - id: no-commit-to-branch # protects `main` by default + - id: trailing-whitespace - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.4.7 From a8956e119463831cd0b7dfad1e7f2f657c434e7d Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Mon, 24 Jun 2024 09:57:07 -0600 Subject: [PATCH 02/20] Fix new errors detected by pre-commit hooks --- .gitattributes | 2 +- binder/postBuild | 1 - docs/howto/access-data.md | 2 -- docs/howto/cloud.md | 2 +- docs/howto/search-collections.md | 2 +- docs/howto/search-granules.md | 2 -- docs/howto/storage-location.md | 2 +- docs/resources.md | 2 -- docs/user-reference/collections/collections-query.md | 1 - docs/user-reference/collections/collections.md | 1 - docs/user-reference/granules/granules-query.md | 1 - docs/user-reference/granules/granules.md | 3 --- 12 files changed, 4 insertions(+), 17 deletions(-) mode change 100644 => 100755 binder/postBuild diff --git a/.gitattributes b/.gitattributes index 01fe5009..affcecd7 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,3 +1,3 @@ notebooks/** linguist-documentation docs/** linguist-documentation -tests/unit/fixtures/vcr_cassettes/** linguist-documentation \ No newline at end of file +tests/unit/fixtures/vcr_cassettes/** linguist-documentation diff --git a/binder/postBuild b/binder/postBuild old mode 100644 new mode 100755 index 254815af..bcf7589f --- a/binder/postBuild +++ b/binder/postBuild @@ -4,4 +4,3 @@ set -ex poetry config virtualenvs.create false poetry install --no-dev - diff --git a/docs/howto/access-data.md b/docs/howto/access-data.md index 22f19521..f87a87f2 100644 --- a/docs/howto/access-data.md +++ b/docs/howto/access-data.md @@ -41,5 +41,3 @@ And that's it in just one line of code! This same piece of code will also work f > More examples coming soon! - - diff --git a/docs/howto/cloud.md b/docs/howto/cloud.md index d3557f72..ebfccf03 100644 --- a/docs/howto/cloud.md +++ b/docs/howto/cloud.md @@ -1,3 +1,3 @@ # Direct S3 access for cloud-based datasets -Coming soon \ No newline at end of file +Coming soon diff --git a/docs/howto/search-collections.md b/docs/howto/search-collections.md index 9b4ee282..517b8629 100644 --- a/docs/howto/search-collections.md +++ b/docs/howto/search-collections.md @@ -1,3 +1,3 @@ # how to search for data collections using spatial, temporal, keyword filters -Coming soon \ No newline at end of file +Coming soon diff --git a/docs/howto/search-granules.md b/docs/howto/search-granules.md index 06286eb9..2926dfa2 100644 --- a/docs/howto/search-granules.md +++ b/docs/howto/search-granules.md @@ -32,5 +32,3 @@ results = earthaccess.search_data( ``` Now that we have our results we can do multiple things: We can iterate over them to get HTTP (or S3) links, we can download the files to a local folder, or we can open these files and stream their content directly to other libraries e.g. xarray. - - diff --git a/docs/howto/storage-location.md b/docs/howto/storage-location.md index f68773d1..83eac95a 100644 --- a/docs/howto/storage-location.md +++ b/docs/howto/storage-location.md @@ -1,3 +1,3 @@ # Determine if a data set is on-prem or in the cloud -Coming soon \ No newline at end of file +Coming soon diff --git a/docs/resources.md b/docs/resources.md index 2421c7c2..341d8d7d 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -5,5 +5,3 @@ * [earthaccess @ AGU poster](https://docs.google.com/presentation/d/1OOSZzbHv6Ck4lzOE01FQdI4kX0VCfcVBS4pWCc7dtBo/edit?usp=sharing) * [NSIDC Cloud Data Access Guide](https://nsidc.org/data/user-resources/help-center/nasa-earthdata-cloud-data-access-guide) - - diff --git a/docs/user-reference/collections/collections-query.md b/docs/user-reference/collections/collections-query.md index e554278f..a59e6926 100644 --- a/docs/user-reference/collections/collections-query.md +++ b/docs/user-reference/collections/collections-query.md @@ -7,4 +7,3 @@ show_source: false inherited_members: true show_source: false - diff --git a/docs/user-reference/collections/collections.md b/docs/user-reference/collections/collections.md index c877360b..e83628b9 100644 --- a/docs/user-reference/collections/collections.md +++ b/docs/user-reference/collections/collections.md @@ -5,4 +5,3 @@ inherited_members: true show_root_heading: true show_source: false - diff --git a/docs/user-reference/granules/granules-query.md b/docs/user-reference/granules/granules-query.md index 78120c0d..75f1adb2 100644 --- a/docs/user-reference/granules/granules-query.md +++ b/docs/user-reference/granules/granules-query.md @@ -8,4 +8,3 @@ inherited_members: true show_root_heading: true show_source: false - diff --git a/docs/user-reference/granules/granules.md b/docs/user-reference/granules/granules.md index 788949ef..e0bbd2c2 100644 --- a/docs/user-reference/granules/granules.md +++ b/docs/user-reference/granules/granules.md @@ -5,6 +5,3 @@ inherited_members: true show_root_heading: true show_source: false - - - From 8556e11686aba6235046bc934ec318cce8f030fc Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 25 Jun 2024 12:33:56 -0600 Subject: [PATCH 03/20] Init PR template --- .github/pull_request_template.md | 36 ++++++++++++++++++++++++++++++++ docs/contributing/index.md | 19 +++-------------- 2 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..6394a631 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ +
PR draft checklist + +Please start by opening this Pull Request as a "draft". You can do this by clicking the +arrow on the right side of the green "Create pull request" button. + +- [ ] Please review our + [contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/) + before getting started. +- [ ] Ensure an issue exists representing the problem being solved in this PR. +- [ ] Link any issues resolved by this PR with text in the PR description, for example + `closes #1`. +- [ ] Update `CHANGELOG.md` with details about your change in a section titled + `## Unreleased`. If such a section does not exist, please create one. +- [ ] Update the documentation and/or the `README.md` with details of changes to the + interface. This includes new environment variables, function names, decorators, + etc. + +Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub +once these requirements are fulfilled. Don't worry if you see any test failures in +GitHub at this point! + +
+ +
PR merge checklist + +Please do your best to complete these requirements! If you need help with any of these +requirements, you can ping the `@nsidc/earthaccess-support` team in a comment and we +will help you out! + +- [ ] Add unit tests for any new features. +- [ ] Apply formatting and linting autofixes. You can add a GitHub comment in this Pull + Request containing "pre-commit.ci autofix" to automate this. +- [ ] Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass. +- [ ] Get at least one approving review. + +
diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 3d149637..b0f24a1b 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -66,21 +66,8 @@ We have included type stubs for the untyped `python-cmr` library, which we intend to eventually upstream. Since `python-cmr` exposes the `cmr` package, the stubs appear under `stubs/cmr`. -### Requirements to merge code (Pull Request Process) - -- you must include test coverage -- you must update the documentation -- you must format and lint - ## Pull Request process -1. Ensure you include test coverage for all changes -1. Ensure your code is formatted properly following this document -1. Update the documentation and the `README.md` with details of changes to the - interface, this includes new environment variables, function names, - decorators, etc. -1. Update `CHANGELOG.md` with details about your change in a section titled - `Unreleased`. If one does not exist, please create one. -1. You may merge the Pull Request once you have the sign-off of another - developer, or if you do not have permission to do that, you may request the - reviewer to merge it for you. +Fork the repository using the "Fork" button on the [repository +homepage](https://github.com/nsidc/earthaccess), make your change on the fork, then open +a pull request from your fork and follow the instructions populated in the text box. From 47a1366f797ed1dc6deecf3e22fed9224f49e06c Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 25 Jun 2024 12:49:07 -0600 Subject: [PATCH 04/20] Clarify the instructional text in the PR template --- .github/pull_request_template.md | 42 +++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6394a631..5b2df6f3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,27 +1,45 @@ -
PR draft checklist - -Please start by opening this Pull Request as a "draft". You can do this by clicking the -arrow on the right side of the green "Create pull request" button. - + + + + +
Pull Request (PR) draft checklist - click to expand + +- [ ] Populate a descriptive title. Ensure the title does not look like "Updated + README.md". +- [ ] Populate the body of the pull request with : + - A clear description of the change you are proposing. + - Links to any issues resolved by this PR with text in the PR description, for + example "closes #1". - [ ] Please review our [contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/) before getting started. - [ ] Ensure an issue exists representing the problem being solved in this PR. -- [ ] Link any issues resolved by this PR with text in the PR description, for example - `closes #1`. - [ ] Update `CHANGELOG.md` with details about your change in a section titled `## Unreleased`. If such a section does not exist, please create one. - [ ] Update the documentation and/or the `README.md` with details of changes to the interface. This includes new environment variables, function names, decorators, etc. - -Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub -once these requirements are fulfilled. Don't worry if you see any test failures in -GitHub at this point! +- [ ] Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub + once these requirements are fulfilled. Don't worry if you see any test failures in + GitHub at this point!
-
PR merge checklist +
Pull Request (PR) merge checklist - click to expand Please do your best to complete these requirements! If you need help with any of these requirements, you can ping the `@nsidc/earthaccess-support` team in a comment and we From f529c35cc18434c2223c12207a45b61e6eb3658b Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 25 Jun 2024 12:49:28 -0600 Subject: [PATCH 05/20] Fix Unreleased section in CHANGELOG to be compatible with our bumpversion config --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c5ee95ac..a0cc813c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## [Unreleased] +## Unreleased ### Changed From a0dacd952e22b31f1131d170f77cd88276c2400b Mon Sep 17 00:00:00 2001 From: asteiker Date: Wed, 3 Jul 2024 16:56:39 +0000 Subject: [PATCH 06/20] removed s3credentials print --- docs/howto/edl.ipynb | 81 +++++++++++++++----------------------------- 1 file changed, 28 insertions(+), 53 deletions(-) diff --git a/docs/howto/edl.ipynb b/docs/howto/edl.ipynb index d26503dc..21313b77 100644 --- a/docs/howto/edl.ipynb +++ b/docs/howto/edl.ipynb @@ -17,17 +17,7 @@ "execution_count": 1, "id": "ce723d6f-8b5f-43e1-9531-19ee08a056fe", "metadata": {}, - "outputs": [ - { - "name": "stdout", - "output_type": "stream", - "text": [ - "You're now authenticated with NASA Earthdata Login\n", - "Using token with expiration date: 09/25/2023\n", - "Using environment variables for EDL\n" - ] - } - ], + "outputs": [], "source": [ "import earthaccess\n", "\n", @@ -40,32 +30,17 @@ "metadata": {}, "source": [ "### Data in AWS\n", - "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs" + "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs. " ] }, { "cell_type": "code", - "execution_count": 3, + "execution_count": 2, "id": "3108ff21-1ea2-449b-b2f5-b442dd3b61f5", "metadata": {}, - "outputs": [ - { - "data": { - "text/plain": [ - "{'accessKeyId': 'ASIA2D3OGJNTE2UAIDHR',\n", - " 'secretAccessKey': '9+6D3m76HTuNi3qvbgUMBFlJECsCgPyJ4ur2CfZL',\n", - " 'sessionToken': 'FwoGZXIvYXdzEPL//////////wEaDIVnMBd6zBaEKmG58CLpAXrPN52vpRHvs+0y960kNwGOdFHPD81WVsdeUciP/vQvsU/xX4Cg+iLH/OXDlH/PBWCmSgfk4vgXD9k6r2JRmnpkwyF4v4K4+ciIuUHNG43ZegSFtkzZoLHShLtEnNu/OIT0TlcrOLJIY+TnjEDcKkXiLSsLYB7qDKZIeg654oPCkjeXyDuoWOumJa7utBEwHmakOGdGJTthOfbfJ6RJ9sbPbmsEXg0bHF5PY9h3/Eoq0rjyRmlb1WYuopw5YK8dL5N9IwSKlKiu19Cj0nd04XVNuiB02+fLDubsnKK1b3j0jR53qAU3FxobKLHgj6YGMi0kDN7xWP6yqI7Ry69Lf5EEcDRVp4UVz6llGYoDpsKr9s3cXaBljkhEjH7N5dQ=',\n", - " 'expiration': '2023-07-28 17:43:29+00:00'}" - ] - }, - "execution_count": 3, - "metadata": {}, - "output_type": "execute_result" - } - ], + "outputs": [], "source": [ - "s3_credentials = auth.get_s3_credentials(\"NSIDC\")\n", - "s3_credentials" + "s3_credentials = auth.get_s3_credentials(\"NSIDC\")" ] }, { @@ -88,7 +63,7 @@ }, { "cell_type": "code", - "execution_count": 14, + "execution_count": 3, "id": "a7bb1a93-6f85-40cd-93b4-ce821a03a8b5", "metadata": {}, "outputs": [], @@ -102,7 +77,7 @@ }, { "cell_type": "code", - "execution_count": 15, + "execution_count": 4, "id": "c0f4e286-8ce9-4cde-b3a2-631b361a0d51", "metadata": {}, "outputs": [ @@ -112,7 +87,7 @@ "'�HDF\\r\\n\\x1a\\n\\x00\\x00\\x00\\x00\\x00\\x08\\x08\\x00\\x04\\x00\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00���������HUn\\x00\\x00\\x00\\x00��������\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00`\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00OHDR\\x02'" ] }, - "execution_count": 15, + "execution_count": 4, "metadata": {}, "output_type": "execute_result" } @@ -133,7 +108,7 @@ }, { "cell_type": "code", - "execution_count": 9, + "execution_count": 5, "id": "1e5f5f7a-0643-42cb-b70c-4ac982824ff9", "metadata": {}, "outputs": [], @@ -143,7 +118,7 @@ }, { "cell_type": "code", - "execution_count": 11, + "execution_count": 6, "id": "fbc7bc5f-b984-4324-b095-3648a437fba2", "metadata": {}, "outputs": [ @@ -153,7 +128,7 @@ "b'\\x89HDF\\r\\n\\x1a\\n\\x00\\x00\\x00\\x00\\x00\\x08\\x08\\x00\\x04\\x00\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xd7HUn\\x00\\x00\\x00\\x00\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00`\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00OHDR'" ] }, - "execution_count": 11, + "execution_count": 6, "metadata": {}, "output_type": "execute_result" } @@ -166,19 +141,19 @@ }, { "cell_type": "code", - "execution_count": 13, + "execution_count": 7, "id": "07433a9f-f276-4d2b-9ed3-f556df2884af", "metadata": {}, "outputs": [ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "f68d214c1c4b4d0fb0b44d878a003a33", + "model_id": "ac15458d5f9e4b8aac40f2e5417b22c7", "version_major": 2, "version_minor": 0 }, "text/plain": [ - "QUEUEING TASKS | : 0it [00:00, ?it/s]" + "QUEUEING TASKS | : 0%| | 0/1 [00:00
<xarray.Dataset>\n",
+       "
<xarray.Dataset> Size: 3kB\n",
        "Dimensions:           (bands: 285)\n",
        "Dimensions without coordinates: bands\n",
        "Data variables:\n",
-       "    wavelengths       (bands) float32 ...\n",
-       "    fwhm              (bands) float32 ...\n",
-       "    good_wavelengths  (bands) float32 ...
"
+       "    wavelengths       (bands) float32 1kB ...\n",
+       "    fwhm              (bands) float32 1kB ...\n",
+       "    good_wavelengths  (bands) float32 1kB ...
" ], "text/plain": [ - "\n", + " Size: 3kB\n", "Dimensions: (bands: 285)\n", "Dimensions without coordinates: bands\n", "Data variables:\n", - " wavelengths (bands) float32 ...\n", - " fwhm (bands) float32 ...\n", - " good_wavelengths (bands) float32 ..." + " wavelengths (bands) float32 1kB ...\n", + " fwhm (bands) float32 1kB ...\n", + " good_wavelengths (bands) float32 1kB ..." ] }, - "execution_count": 13, + "execution_count": 7, "metadata": {}, "output_type": "execute_result" } @@ -638,7 +613,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.16" + "version": "3.10.14" } }, "nbformat": 4, From a63f04fc6231b5c00b0a83afe9ab9dd1e88c8908 Mon Sep 17 00:00:00 2001 From: asteiker Date: Wed, 3 Jul 2024 17:00:52 +0000 Subject: [PATCH 07/20] comment s3credential line --- docs/howto/edl.ipynb | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/howto/edl.ipynb b/docs/howto/edl.ipynb index 21313b77..84a60948 100644 --- a/docs/howto/edl.ipynb +++ b/docs/howto/edl.ipynb @@ -30,17 +30,11 @@ "metadata": {}, "source": [ "### Data in AWS\n", - "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs. " - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "id": "3108ff21-1ea2-449b-b2f5-b442dd3b61f5", - "metadata": {}, - "outputs": [], - "source": [ - "s3_credentials = auth.get_s3_credentials(\"NSIDC\")" + "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs:\n", + "\n", + "```\n", + "s3_credentials = auth.get_s3_credentials(\"NSIDC\")\n", + "```" ] }, { From 4de295b81a0cd81a6c39456365f1c9a4cda50feb Mon Sep 17 00:00:00 2001 From: asteiker Date: Wed, 3 Jul 2024 17:06:45 +0000 Subject: [PATCH 08/20] remove s3credential line --- docs/howto/edl.ipynb | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/howto/edl.ipynb b/docs/howto/edl.ipynb index 84a60948..ce9b967c 100644 --- a/docs/howto/edl.ipynb +++ b/docs/howto/edl.ipynb @@ -57,7 +57,7 @@ }, { "cell_type": "code", - "execution_count": 3, + "execution_count": 2, "id": "a7bb1a93-6f85-40cd-93b4-ce821a03a8b5", "metadata": {}, "outputs": [], @@ -71,7 +71,7 @@ }, { "cell_type": "code", - "execution_count": 4, + "execution_count": 3, "id": "c0f4e286-8ce9-4cde-b3a2-631b361a0d51", "metadata": {}, "outputs": [ @@ -81,7 +81,7 @@ "'�HDF\\r\\n\\x1a\\n\\x00\\x00\\x00\\x00\\x00\\x08\\x08\\x00\\x04\\x00\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00���������HUn\\x00\\x00\\x00\\x00��������\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00`\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00OHDR\\x02'" ] }, - "execution_count": 4, + "execution_count": 3, "metadata": {}, "output_type": "execute_result" } @@ -102,7 +102,7 @@ }, { "cell_type": "code", - "execution_count": 5, + "execution_count": 4, "id": "1e5f5f7a-0643-42cb-b70c-4ac982824ff9", "metadata": {}, "outputs": [], @@ -112,7 +112,7 @@ }, { "cell_type": "code", - "execution_count": 6, + "execution_count": 5, "id": "fbc7bc5f-b984-4324-b095-3648a437fba2", "metadata": {}, "outputs": [ @@ -122,7 +122,7 @@ "b'\\x89HDF\\r\\n\\x1a\\n\\x00\\x00\\x00\\x00\\x00\\x08\\x08\\x00\\x04\\x00\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xd7HUn\\x00\\x00\\x00\\x00\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00`\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00OHDR'" ] }, - "execution_count": 6, + "execution_count": 5, "metadata": {}, "output_type": "execute_result" } @@ -135,14 +135,14 @@ }, { "cell_type": "code", - "execution_count": 7, + "execution_count": 6, "id": "07433a9f-f276-4d2b-9ed3-f556df2884af", "metadata": {}, "outputs": [ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "ac15458d5f9e4b8aac40f2e5417b22c7", + "model_id": "9e8e316215154002afe0c89ccc174a04", "version_major": 2, "version_minor": 0 }, @@ -156,7 +156,7 @@ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "100cb212635146bab6548c8bf171d970", + "model_id": "ff1c8adf11a04dc4aa799fe45aa7460d", "version_major": 2, "version_minor": 0 }, @@ -170,7 +170,7 @@ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "3754ed8d0297407cade522b651c59ead", + "model_id": "77eac7c793e7416bb91196733769f3fe", "version_major": 2, "version_minor": 0 }, @@ -185,8 +185,8 @@ "name": "stdout", "output_type": "stream", "text": [ - "CPU times: user 2.73 s, sys: 241 ms, total: 2.97 s\n", - "Wall time: 10.9 s\n" + "CPU times: user 1.37 s, sys: 207 ms, total: 1.58 s\n", + "Wall time: 11.8 s\n" ] }, { @@ -561,7 +561,7 @@ "Data variables:\n", " wavelengths (bands) float32 1kB ...\n", " fwhm (bands) float32 1kB ...\n", - " good_wavelengths (bands) float32 1kB ..." + " good_wavelengths (bands) float32 1kB ..." ], "text/plain": [ " Size: 3kB\n", @@ -573,7 +573,7 @@ " good_wavelengths (bands) float32 1kB ..." ] }, - "execution_count": 7, + "execution_count": 6, "metadata": {}, "output_type": "execute_result" } From 9c75e7d16f84919db11d3ffcb11f9d6b52993d9e Mon Sep 17 00:00:00 2001 From: asteiker Date: Wed, 3 Jul 2024 18:19:18 +0000 Subject: [PATCH 09/20] comment s3credential line --- docs/howto/edl.ipynb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto/edl.ipynb b/docs/howto/edl.ipynb index ce9b967c..dcc7727a 100644 --- a/docs/howto/edl.ipynb +++ b/docs/howto/edl.ipynb @@ -30,7 +30,7 @@ "metadata": {}, "source": [ "### Data in AWS\n", - "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs:\n", + "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs. This line is commented out for security reasons. Please copy the following line into a new code block in order to obtain your credentials. \n", "\n", "```\n", "s3_credentials = auth.get_s3_credentials(\"NSIDC\")\n", From 5bc9fb95494f25302ffe40e7f20eedfc2953a8f6 Mon Sep 17 00:00:00 2001 From: asteiker Date: Wed, 3 Jul 2024 19:10:47 +0000 Subject: [PATCH 10/20] move s3credential to commented code cell --- docs/howto/edl.ipynb | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/docs/howto/edl.ipynb b/docs/howto/edl.ipynb index dcc7727a..5949ddb5 100644 --- a/docs/howto/edl.ipynb +++ b/docs/howto/edl.ipynb @@ -30,11 +30,17 @@ "metadata": {}, "source": [ "### Data in AWS\n", - "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs. This line is commented out for security reasons. Please copy the following line into a new code block in order to obtain your credentials. \n", - "\n", - "```\n", - "s3_credentials = auth.get_s3_credentials(\"NSIDC\")\n", - "```" + "If the data we want to access is on AWS, we can use earthaccess to generate temporary S3 credentials for any of the DAACs. This line is commented out for security reasons. " + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "f1f45172-c9c3-4f25-ad7e-acf94fba8b1d", + "metadata": {}, + "outputs": [], + "source": [ + "#s3_credentials = auth.get_s3_credentials(\"NSIDC\")" ] }, { @@ -57,7 +63,7 @@ }, { "cell_type": "code", - "execution_count": 2, + "execution_count": 3, "id": "a7bb1a93-6f85-40cd-93b4-ce821a03a8b5", "metadata": {}, "outputs": [], @@ -71,7 +77,7 @@ }, { "cell_type": "code", - "execution_count": 3, + "execution_count": 4, "id": "c0f4e286-8ce9-4cde-b3a2-631b361a0d51", "metadata": {}, "outputs": [ @@ -81,7 +87,7 @@ "'�HDF\\r\\n\\x1a\\n\\x00\\x00\\x00\\x00\\x00\\x08\\x08\\x00\\x04\\x00\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00���������HUn\\x00\\x00\\x00\\x00��������\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00`\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00OHDR\\x02'" ] }, - "execution_count": 3, + "execution_count": 4, "metadata": {}, "output_type": "execute_result" } @@ -102,7 +108,7 @@ }, { "cell_type": "code", - "execution_count": 4, + "execution_count": 5, "id": "1e5f5f7a-0643-42cb-b70c-4ac982824ff9", "metadata": {}, "outputs": [], @@ -112,7 +118,7 @@ }, { "cell_type": "code", - "execution_count": 5, + "execution_count": 6, "id": "fbc7bc5f-b984-4324-b095-3648a437fba2", "metadata": {}, "outputs": [ @@ -122,7 +128,7 @@ "b'\\x89HDF\\r\\n\\x1a\\n\\x00\\x00\\x00\\x00\\x00\\x08\\x08\\x00\\x04\\x00\\x10\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xd7HUn\\x00\\x00\\x00\\x00\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\xff\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00`\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00\\x00OHDR'" ] }, - "execution_count": 5, + "execution_count": 6, "metadata": {}, "output_type": "execute_result" } @@ -135,14 +141,14 @@ }, { "cell_type": "code", - "execution_count": 6, + "execution_count": 7, "id": "07433a9f-f276-4d2b-9ed3-f556df2884af", "metadata": {}, "outputs": [ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "9e8e316215154002afe0c89ccc174a04", + "model_id": "c76e3afc58a84118a04144f2f08ff6bc", "version_major": 2, "version_minor": 0 }, @@ -156,7 +162,7 @@ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "ff1c8adf11a04dc4aa799fe45aa7460d", + "model_id": "98f4219952eb4e9bb8f60ad67f438454", "version_major": 2, "version_minor": 0 }, @@ -170,7 +176,7 @@ { "data": { "application/vnd.jupyter.widget-view+json": { - "model_id": "77eac7c793e7416bb91196733769f3fe", + "model_id": "9451a7fda27e4569968054028576999d", "version_major": 2, "version_minor": 0 }, @@ -185,8 +191,8 @@ "name": "stdout", "output_type": "stream", "text": [ - "CPU times: user 1.37 s, sys: 207 ms, total: 1.58 s\n", - "Wall time: 11.8 s\n" + "CPU times: user 1.4 s, sys: 179 ms, total: 1.58 s\n", + "Wall time: 10.5 s\n" ] }, { @@ -561,7 +567,7 @@ "Data variables:\n", " wavelengths (bands) float32 1kB ...\n", " fwhm (bands) float32 1kB ...\n", - " good_wavelengths (bands) float32 1kB ..." + " good_wavelengths (bands) float32 1kB ..." ], "text/plain": [ " Size: 3kB\n", @@ -573,7 +579,7 @@ " good_wavelengths (bands) float32 1kB ..." ] }, - "execution_count": 6, + "execution_count": 7, "metadata": {}, "output_type": "execute_result" } From f44decbd32cb4da8c46192206e6265dcf69b0f5d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 6 Jul 2024 15:05:30 +0000 Subject: [PATCH 11/20] Bump certifi from 2024.6.2 to 2024.7.4 Bumps [certifi](https://github.com/certifi/python-certifi) from 2024.6.2 to 2024.7.4. - [Commits](https://github.com/certifi/python-certifi/compare/2024.06.02...2024.07.04) --- updated-dependencies: - dependency-name: certifi dependency-type: indirect ... Signed-off-by: dependabot[bot] --- poetry.lock | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/poetry.lock b/poetry.lock index 00d277a3..10e0260f 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. [[package]] name = "aiobotocore" @@ -462,13 +462,13 @@ test = ["coverage", "freezegun", "pre-commit", "pytest", "pytest-cov", "pytest-m [[package]] name = "certifi" -version = "2024.6.2" +version = "2024.7.4" description = "Python package for providing Mozilla's CA Bundle." optional = false python-versions = ">=3.6" files = [ - {file = "certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56"}, - {file = "certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516"}, + {file = "certifi-2024.7.4-py3-none-any.whl", hash = "sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90"}, + {file = "certifi-2024.7.4.tar.gz", hash = "sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b"}, ] [[package]] From 91e559990659fa77e1bc68452f8bbde220e292ee Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Sat, 6 Jul 2024 11:19:06 -0600 Subject: [PATCH 12/20] Clarify "descriptive title" task Co-Authored-By: danielfromearth --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5b2df6f3..8971a273 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,8 +18,8 @@ the PR as a non-draft, don't worry, you can still change it to a draft using the
Pull Request (PR) draft checklist - click to expand -- [ ] Populate a descriptive title. Ensure the title does not look like "Updated - README.md". +- [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a + title such as "Add testing details to the contributor section of the README". - [ ] Populate the body of the pull request with : - A clear description of the change you are proposing. - Links to any issues resolved by this PR with text in the PR description, for From f058822173cce6cbfa03edb5def895352b6fd1f8 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Sat, 6 Jul 2024 11:25:58 -0600 Subject: [PATCH 13/20] Move items that belong at the top of the checklist to the top Co-Authored-By: danielfromearth --- .github/pull_request_template.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8971a273..40f3938e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,16 +18,16 @@ the PR as a non-draft, don't worry, you can still change it to a draft using the
Pull Request (PR) draft checklist - click to expand +- [ ] Please review our + [contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/) + before getting started. +- [ ] Ensure an issue exists representing the problem being solved in this PR. - [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a title such as "Add testing details to the contributor section of the README". - [ ] Populate the body of the pull request with : - A clear description of the change you are proposing. - Links to any issues resolved by this PR with text in the PR description, for example "closes #1". -- [ ] Please review our - [contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/) - before getting started. -- [ ] Ensure an issue exists representing the problem being solved in this PR. - [ ] Update `CHANGELOG.md` with details about your change in a section titled `## Unreleased`. If such a section does not exist, please create one. - [ ] Update the documentation and/or the `README.md` with details of changes to the From d5c5aaa8f964df8e129af71f30f3e6390197668b Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Sat, 6 Jul 2024 11:32:29 -0600 Subject: [PATCH 14/20] Clarify expectations for maintainer attention Co-Authored-By: Ian Carroll --- .github/pull_request_template.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 40f3938e..2c8ec43c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,9 +10,12 @@ expect you to complete the steps in the "PR draft checklist" below. Maintainers willing and ready to help pick it up from there! Please start by opening this Pull Request as a "draft". You can do this by -clicking the arrow on the right side of the green "Create pull request" button. Follow -the draft checklist below to move the PR out of draft state. If you accidentally created -the PR as a non-draft, don't worry, you can still change it to a draft using the +clicking the arrow on the right side of the green "Create pull request" button. While +your pull request is in "draft" state, maintainers will assume the PR isn't ready for +their attention unless they are specifically summoned using GitHub's @ system. + +Follow the draft checklist below to move the PR out of draft state. If you accidentally +created the PR as a non-draft, don't worry, you can still change it to a draft using the "Convert to draft" button on the right side panel under the "Reviewers" section. --> From 7e34898e2dded37f526532730e320b86cceb59c1 Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Sat, 6 Jul 2024 11:33:55 -0600 Subject: [PATCH 15/20] Un-checkbox "ready for review" instructions Co-Authored-By: Ian Carroll --- .github/pull_request_template.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2c8ec43c..71a136f6 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -36,9 +36,10 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u - [ ] Update the documentation and/or the `README.md` with details of changes to the interface. This includes new environment variables, function names, decorators, etc. -- [ ] Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub - once these requirements are fulfilled. Don't worry if you see any test failures in - GitHub at this point! + +Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub +once these requirements are fulfilled. Don't worry if you see any test failures in +GitHub at this point!
From 3cb282b877cdc603872c1b502224a0e6b4bcb47b Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Sat, 6 Jul 2024 11:34:13 -0600 Subject: [PATCH 16/20] Clarify draft PR instructions --- .github/pull_request_template.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 71a136f6..60c23104 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,15 +27,16 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u - [ ] Ensure an issue exists representing the problem being solved in this PR. - [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a title such as "Add testing details to the contributor section of the README". -- [ ] Populate the body of the pull request with : +- [ ] Populate the body of the pull request with: - A clear description of the change you are proposing. - Links to any issues resolved by this PR with text in the PR description, for - example "closes #1". + example `closes #1`. See + [GitHub docs - Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - [ ] Update `CHANGELOG.md` with details about your change in a section titled `## Unreleased`. If such a section does not exist, please create one. - [ ] Update the documentation and/or the `README.md` with details of changes to the - interface. This includes new environment variables, function names, decorators, - etc. + earthaccess interface, if any. Consider new environment variables, function names, + decorators, etc. Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub once these requirements are fulfilled. Don't worry if you see any test failures in From 805c65598437ba81344a733ed4c449d8b760e40c Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Sat, 6 Jul 2024 11:43:19 -0600 Subject: [PATCH 17/20] Make PR instructions clearer and more welcoming Co-authored-by: Ian Carroll --- docs/contributing/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contributing/index.md b/docs/contributing/index.md index b0f24a1b..fc39f629 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -69,5 +69,6 @@ the stubs appear under `stubs/cmr`. ## Pull Request process Fork the repository using the "Fork" button on the [repository -homepage](https://github.com/nsidc/earthaccess), make your change on the fork, then open -a pull request from your fork and follow the instructions populated in the text box. +homepage](https://github.com/nsidc/earthaccess), create a branch with your changes in the fork, then open +a draft pull request from your fork. Starting a pull request provides additional instructions and requirements, and +there is no harm in starting a draft pull request while still developing. From 728eb17e52738f62dcd08d86093da7fa7bde1a3d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sat, 6 Jul 2024 18:57:36 +0000 Subject: [PATCH 18/20] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/contributing/maintainers-guide.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/contributing/maintainers-guide.md b/docs/contributing/maintainers-guide.md index 1ac2fc79..2d54a354 100644 --- a/docs/contributing/maintainers-guide.md +++ b/docs/contributing/maintainers-guide.md @@ -53,6 +53,3 @@ The GitHub Actions CI services handle the project's building, testing, and manag ## Continuous Documentation [ReadTheDocs](https://readthedocs.org/projects/earthaccess/) is used to generate and host [our documentation website](https://earthaccess.readthedocs.io/) as well as the preview for documentation changes made in pull requests. This service uses a configuration file in the root of the project, `.readthedocs.yml`. - - - From a3ce75cf72dbe5d4bacc74c79827a8826634749b Mon Sep 17 00:00:00 2001 From: jbrownrs <36203116+jbrownrs@users.noreply.github.com> Date: Mon, 8 Jul 2024 22:56:56 +0100 Subject: [PATCH 19/20] 427: Fix broken image link in sea level rise tutorial --- CHANGELOG.md | 2 ++ docs/tutorials/SSL.ipynb | 10 +++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c5ee95ac..2252ba95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -39,6 +39,8 @@ ([#508](https://github.com/nsidc/earthaccess/issues/508)) * Create destination directory prior to direct S3 downloads, if it doesn't already exist ([#562](https://github.com/nsidc/earthaccess/issues/562)) +* Fix broken image link in sea level rise tutorial + (([#427](https://github.com/nsidc/earthaccess/issues/427)) ## [v0.9.0] 2024-02-28 diff --git a/docs/tutorials/SSL.ipynb b/docs/tutorials/SSL.ipynb index 75182d4b..265f1fd7 100644 --- a/docs/tutorials/SSL.ipynb +++ b/docs/tutorials/SSL.ipynb @@ -10,7 +10,7 @@ "\n", "### This notebook is entirely based on Jinbo Wang's [tutorial](https://github.com/betolink/the-coding-club/blob/main/notebooks/Earthdata_webinar_20220727.ipynb)\n", "\n", - "\n", + "\"Sea\n", "\n", "--- \n", "\n", @@ -157,11 +157,11 @@ " * not fully tested with Dask distributed\n", "* Data is gridded\n", " * xarray works better with homogeneous coordinates, working with swath data will be cumbersome.\n", - "* Data is chunked using reasonable large sizes(1MB or more)\n", + "* Data is chunked using reasonable large sizes (1MB or more)\n", " * If our files are chunked in small pieces the access time will be orders of magnitude bigger than just downloading the data and accessing it locally.\n", " \n", - "Opening a year of SSH (SEA_SURFACE_HEIGHT_ALT_GRIDS_L4_2SATS_5DAY_6THDEG_V_JPL1812) data (1.1 GB approx) can take up to 5 minutes streaming the data out of region(not in AWS)\n", - "The reason for this is not that the data transfer is order of magintude slower but due the client libraries not fetching data concurrently and the metadata of the files in HDF is usually not consolidated like in Zaar, hence h5netcdf has to issue a lot of requests to get the info it needs.\n", + "Opening a year of SSH (SEA_SURFACE_HEIGHT_ALT_GRIDS_L4_2SATS_5DAY_6THDEG_V_JPL1812) data (1.1 GB approx) can take up to 5 minutes streaming the data out of region (not in AWS)\n", + "The reason for this is not that the data transfer is order of magnitude slower but due the client libraries not fetching data concurrently and the metadata of the files in HDF is usually not consolidated like in Zaar, hence h5netcdf has to issue a lot of requests to get the info it needs.\n", "\n", "> Note: we are looping through each year and getting the metadata for the first granule in May" ] @@ -195,7 +195,7 @@ "id": "8b63ca2f-c94c-4d4a-a620-a086ee66137f", "metadata": {}, "source": [ - "### What `earthaccess.open()` do?\n", + "### What does `earthaccess.open()` do?\n", "\n", "`earthaccess.open()` takes a list of results from `earthaccess.search_data()` or a list of URLs and creates a list of Python File-like objects that can be used in our code as if the remote files were local. When executed in AWS the file system used is [S3FS](https://github.com/fsspec/s3fs) when we open files outside of AWS we get a regular HTTPS file session. \n" ] From 2c065f0ca73872b7c899f8ceb234be77b0ff29f3 Mon Sep 17 00:00:00 2001 From: jbrownrs <36203116+jbrownrs@users.noreply.github.com> Date: Mon, 8 Jul 2024 23:39:41 +0100 Subject: [PATCH 20/20] 427: Remove blank lines in maintainers-guide.md (pre-commit) --- docs/contributing/maintainers-guide.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/contributing/maintainers-guide.md b/docs/contributing/maintainers-guide.md index 1ac2fc79..2d54a354 100644 --- a/docs/contributing/maintainers-guide.md +++ b/docs/contributing/maintainers-guide.md @@ -53,6 +53,3 @@ The GitHub Actions CI services handle the project's building, testing, and manag ## Continuous Documentation [ReadTheDocs](https://readthedocs.org/projects/earthaccess/) is used to generate and host [our documentation website](https://earthaccess.readthedocs.io/) as well as the preview for documentation changes made in pull requests. This service uses a configuration file in the root of the project, `.readthedocs.yml`. - - -