From 8d46bb9fb3d9710e789805d059417905ef3337fe Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:02:15 +0000 Subject: [PATCH 1/9] Update docs/howto_guides/asdf_warnings.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/asdf_warnings.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/asdf_warnings.rst b/docs/howto_guides/asdf_warnings.rst index a85131f3..ba3d9b54 100644 --- a/docs/howto_guides/asdf_warnings.rst +++ b/docs/howto_guides/asdf_warnings.rst @@ -1,7 +1,7 @@ .. _dkist:howto-guide:asdf-warnings Understand version warnings when loading ASDFs -================================================= +============================================== When you load a recently-downloaded ASDF file you may see a warning something like this: From c5bb1673d92cb4dba62b7828fad0f77f1ea5f0a5 Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:02:41 +0000 Subject: [PATCH 2/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index 81a455eb..62554e85 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -16,7 +16,7 @@ For example: .. code-block:: python - Fido.fetch(res, path="~/sunpy/data/{instrument}/{dataset_id}", overwrite=True) # doctest: +SKIP + Fido.fetch(res, path="~/sunpy/data/{instrument}/{dataset_id}", overwrite=True) # doctest: +SKIP where `res` is the result of a `Fido` search for some dataset you already have saved locally. From 5b03110213c4534587b232e7efa520c03a29e1a7 Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:02:54 +0000 Subject: [PATCH 3/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index 62554e85..9986a0e99 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -28,7 +28,7 @@ Again, we can use the `overwrite` keyword for this. from dkist.data.sample import download_all_sample_data - download_all_sample_data(overwrite=True) # doctest: +REMOTE_DATA + download_all_sample_data(overwrite=True) # doctest: +REMOTE_DATA Occasionally, the naming convention for the ASDF files has also changed, meaning that the usual checks to stop you downloading a dataset you already have locally may fail and you will end up with two (likely identical) metadata files. From 9dd9fb9b0ce2fe7f9888e4a411386e61bb0c8669 Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:03:09 +0000 Subject: [PATCH 4/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index 9986a0e99..fddb0b07 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -19,7 +19,7 @@ For example: Fido.fetch(res, path="~/sunpy/data/{instrument}/{dataset_id}", overwrite=True) # doctest: +SKIP -where `res` is the result of a `Fido` search for some dataset you already have saved locally. +where ``res`` is the result of a ``Fido`` search for some dataset you already have saved locally. You might also need to force a refresh of the sample data which is included with the Python tools. Again, we can use the `overwrite` keyword for this. From 7e84dee2223924ad6c37a808cbf2fba4c4897188 Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:03:25 +0000 Subject: [PATCH 5/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index fddb0b07..8f402ae1 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -22,7 +22,7 @@ For example: where ``res`` is the result of a ``Fido`` search for some dataset you already have saved locally. You might also need to force a refresh of the sample data which is included with the Python tools. -Again, we can use the `overwrite` keyword for this. +Again, we can use the ``overwrite`` keyword for this. .. code-block:: python From 5cccefaca837bd5a71f5806faf5e7d3a2f6819f4 Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:04:00 +0000 Subject: [PATCH 6/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index 8f402ae1..c3a7e695 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -32,7 +32,7 @@ Again, we can use the ``overwrite`` keyword for this. Occasionally, the naming convention for the ASDF files has also changed, meaning that the usual checks to stop you downloading a dataset you already have locally may fail and you will end up with two (likely identical) metadata files. -If you re-download a dataset that you already had locally before the rename, you may see a warning like this when you load the dataset: +If you try and load a dataset where a file with an old name is present you will see a warning similar to this: .. code-block:: python From f8c94925b95723584e5c652c5f2ffb6c054b7b6f Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:04:20 +0000 Subject: [PATCH 7/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index c3a7e695..4f4cbfef 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -31,7 +31,7 @@ Again, we can use the ``overwrite`` keyword for this. download_all_sample_data(overwrite=True) # doctest: +REMOTE_DATA -Occasionally, the naming convention for the ASDF files has also changed, meaning that the usual checks to stop you downloading a dataset you already have locally may fail and you will end up with two (likely identical) metadata files. +In the past, the naming convention for the metadata ASDF files has also changed, meaning that the usual checks to stop you downloading a dataset you already have locally may fail and you will end up with two separate metadata files. If you try and load a dataset where a file with an old name is present you will see a warning similar to this: .. code-block:: python From 1015e4d6bf1de78978da4dd3cf91c64e1a7dbd2b Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:04:34 +0000 Subject: [PATCH 8/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index 4f4cbfef..d7ab103a 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -45,6 +45,6 @@ If you try and load a dataset where a file with an old name is present you will When this happens the newer ASDF file is loaded so the old one can safely be ignored. However, to remove the warning the old file can simply be deleted or moved elsewhere. -Note that this behaviour is new in dkist v1.10.0. +Note that this warning was added in dkist version 1.10.0. In older versions the loader will return a list containing the corresponding dataset for each ASDF file present, which is likely to cause problems. Deleting the old file will still solve the issue, although you should also update your Python tools installation to v1.10.1 or later if possible. From 7c4967c8cb338667495bf8d57f6a185c0345a018 Mon Sep 17 00:00:00 2001 From: Drew Leonard Date: Tue, 18 Feb 2025 16:05:25 +0000 Subject: [PATCH 9/9] Update docs/howto_guides/replacing_asdfs.rst Co-authored-by: Stuart Mumford --- docs/howto_guides/replacing_asdfs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto_guides/replacing_asdfs.rst b/docs/howto_guides/replacing_asdfs.rst index d7ab103a..71cace49 100644 --- a/docs/howto_guides/replacing_asdfs.rst +++ b/docs/howto_guides/replacing_asdfs.rst @@ -47,4 +47,4 @@ However, to remove the warning the old file can simply be deleted or moved elsew Note that this warning was added in dkist version 1.10.0. In older versions the loader will return a list containing the corresponding dataset for each ASDF file present, which is likely to cause problems. -Deleting the old file will still solve the issue, although you should also update your Python tools installation to v1.10.1 or later if possible. +Deleting the old file will still solve the issue, although you should also update your Python tools installation to v1.10.0 or later.