build based on 8fdc7ce

oxinabox · Feb 13, 2024 · e623982 · e623982
1 parent f0ad3b9
commit e623982
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 11 deletions.
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/search/index.html b/dev/search/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · DataDeps.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">DataDeps.jl</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">DataDeps.jl Documentation</a></li><li><a class="tocitem" href="../z10-for-end-users/">Usage for end-users</a></li><li><a class="tocitem" href="../z20-for-pkg-devs/">Usage for developers (including researchers)</a></li><li><a class="tocitem" href="../z30-for-contributors/">Extending DataDeps.jl for Contributors</a></li><li><a class="tocitem" href="../z40-apiref/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Friday 19 January 2024 04:02">Friday 19 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Search · DataDeps.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">DataDeps.jl</span></div><form class="docs-search" action><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">DataDeps.jl Documentation</a></li><li><a class="tocitem" href="../z10-for-end-users/">Usage for end-users</a></li><li><a class="tocitem" href="../z20-for-pkg-devs/">Usage for developers (including researchers)</a></li><li><a class="tocitem" href="../z30-for-contributors/">Extending DataDeps.jl for Contributors</a></li><li><a class="tocitem" href="../z40-apiref/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Search</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Search</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article><p id="documenter-search-info">Loading search...</p><ul id="documenter-search-results"></ul></article></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 13 February 2024 03:04">Tuesday 13 February 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body><script src="../search_index.js"></script><script src="../assets/search.js"></script></html>
diff --git a/dev/z10-for-end-users/index.html b/dev/z10-for-end-users/index.html
@@ -9,4 +9,4 @@
 C:\Users\oxinabox\AppData\Roaming\datadeps
 C:\Users\oxinabox\AppData\Local\datadeps
 C:\ProgramData\datadeps
-C:\Users\Public\datadeps</code></pre><h3 id="Having-multiple-copies-of-the-same-DataDir-1"><a class="docs-heading-anchor" href="#Having-multiple-copies-of-the-same-DataDir-1">Having multiple copies of the same DataDir</a><a class="docs-heading-anchor-permalink" href="#Having-multiple-copies-of-the-same-DataDir-1" title="Permalink"></a></h3><p>You probably don&#39;t want to have multiple copies of a DataDir with the same name. DataDeps.jl will try to handle it as gracefully as it can. But having different <code>DataDep</code>s under the same name, is probably going to lead to packages loading the wrong one. Except if they are (both) located in their packages <code>deps/data</code> folder.</p><p>By moving a package&#39;s data dependency into its package directory under <code>deps/data</code>, it becomes invisible except to that package. For example <code>~/.julia/v0.6/EXAMPLEPKG/deps/data/EXAMPLEDATADEP/</code>, for the package <code>EXAMPLEPKG</code>, and the datadep <code>EXAMPLEDATADEP</code>.</p><p>Ideally though you should probably raise an issue with the package maintainers and see if one (or both) of them want to change the DataDep name.</p><p>Note also when it comes to file level loading, e.g. <code>datadep&quot;Name/subfolder/file.txt&quot;</code>, DataDeps.jl does not check all folders with that <code>Name</code> (if you have multiples). If the file is not in the first folder it finds you will be presented with the recovery dialog, from which the easiest option is to select to delete the folder and retry, since that will result in it checking the second folder (as the first one does not exist).</p><h2 id="Removing-data-1"><a class="docs-heading-anchor" href="#Removing-data-1">Removing data</a><a class="docs-heading-anchor-permalink" href="#Removing-data-1" title="Permalink"></a></h2><p>Sometimes you don&#39;t need the data anymore. You can remove files from within Julia using the <code>rm</code> command. If you had registered a <code>DataDep</code> called <code>MyDataName</code>, then you can remove it with</p><pre><code class="language-none">rm(datadep&quot;MyDataName&quot;; recursive=true)</code></pre><h2 id="Configuration-1"><a class="docs-heading-anchor" href="#Configuration-1">Configuration</a><a class="docs-heading-anchor-permalink" href="#Configuration-1" title="Permalink"></a></h2><p>Currently configuration is done via Environment Variables. It is likely to stay that way, as they are also easy to setup in CI tools. You can set these in the <a href="https://docs.julialang.org/en/v1/manual/getting-started/"><code>startup.jl</code></a> file using the <code>ENV</code> dictionary if you don&#39;t want to mess up your <code>.profile</code>. However, most people shouldn&#39;t need to. DataDeps.jl tries to have very sensible defaults.</p><ul><li><code>DATADEPS_ALWAYS_ACCEPT</code> – bypasses the confirmation before downloading data. Set to <code>true</code> (or similar string)<ul><li>default: <code>false</code></li><li>Note that it remains your responsibility to understand and read any terms of the data use (this is remains true even if you don&#39;t turn on this bypass)</li><li>This is provided for scripting (in particular CI) use</li><li>If the <code>CI</code> environment variable is set to true, <code>DATADEPS_ALWAYS_ACCEPT</code>  <strong>must be set</strong> to true or false. This is to prevent hanging in CI.</li></ul></li><li><code>DATADEPS_PROGRESS_UPDATE_PERIOD</code> – how often (in seconds) to print the progress to the log for the download<ul><li>This is used by the default <code>fetch_method</code> and when implementing custom methods it is good to respect it.</li><li>default: <code>5</code> (seconds) usually; <code>Inf</code> (i.e. no updates) if <code>DATADEPS_ALWAYS_ACCEPT</code> is set.</li></ul></li><li><code>DATADEPS_LOAD_PATH</code> – The list of paths to be prepended to the standard load path to save and load data from<ul><li>By default this is empty, but it can be a colon separated list (like most unix path variables). <a href="#The-Load-Path">For more details see above.</a></li></ul></li><li><code>DATADEPS_NO_STANDARD_LOAD_PATH</code> if this is set to <code>true</code> (default <code>false</code>), then the aforementioned list of standard load path files is not included</li><li><code>DATADEPS_DISABLE_DOWNLOAD</code> – causes any action that would result in the download being triggered to throw an exception.<ul><li>useful e.g. if you are in an environment with metered data, where your datasets should have already been downloaded earlier, and if there were not you want to respond to the situation rather than let DataDeps.jl download them for you.</li><li>default <code>false</code></li></ul></li><li><code>DATADEPS_DISABLE_ERROR_CLEANUP</code> – By default DataDeps.jl will cleanup the directory the datadep was being downloaded to if there is an error during the resolution (In any of the <code>fetch</code>, <code>checksum</code>, or <code>post_fetch</code>). For debugging purposes you may wish to disable this cleanup step so you can interrogate the files by hand.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« DataDeps.jl Documentation</a><a class="docs-footer-nextpage" href="../z20-for-pkg-devs/">Usage for developers (including researchers) »</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Friday 19 January 2024 04:02">Friday 19 January 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+C:\Users\Public\datadeps</code></pre><h3 id="Having-multiple-copies-of-the-same-DataDir-1"><a class="docs-heading-anchor" href="#Having-multiple-copies-of-the-same-DataDir-1">Having multiple copies of the same DataDir</a><a class="docs-heading-anchor-permalink" href="#Having-multiple-copies-of-the-same-DataDir-1" title="Permalink"></a></h3><p>You probably don&#39;t want to have multiple copies of a DataDir with the same name. DataDeps.jl will try to handle it as gracefully as it can. But having different <code>DataDep</code>s under the same name, is probably going to lead to packages loading the wrong one. Except if they are (both) located in their packages <code>deps/data</code> folder.</p><p>By moving a package&#39;s data dependency into its package directory under <code>deps/data</code>, it becomes invisible except to that package. For example <code>~/.julia/v0.6/EXAMPLEPKG/deps/data/EXAMPLEDATADEP/</code>, for the package <code>EXAMPLEPKG</code>, and the datadep <code>EXAMPLEDATADEP</code>.</p><p>Ideally though you should probably raise an issue with the package maintainers and see if one (or both) of them want to change the DataDep name.</p><p>Note also when it comes to file level loading, e.g. <code>datadep&quot;Name/subfolder/file.txt&quot;</code>, DataDeps.jl does not check all folders with that <code>Name</code> (if you have multiples). If the file is not in the first folder it finds you will be presented with the recovery dialog, from which the easiest option is to select to delete the folder and retry, since that will result in it checking the second folder (as the first one does not exist).</p><h2 id="Removing-data-1"><a class="docs-heading-anchor" href="#Removing-data-1">Removing data</a><a class="docs-heading-anchor-permalink" href="#Removing-data-1" title="Permalink"></a></h2><p>Sometimes you don&#39;t need the data anymore. You can remove files from within Julia using the <code>rm</code> command. If you had registered a <code>DataDep</code> called <code>MyDataName</code>, then you can remove it with</p><pre><code class="language-none">rm(datadep&quot;MyDataName&quot;; recursive=true)</code></pre><h2 id="Configuration-1"><a class="docs-heading-anchor" href="#Configuration-1">Configuration</a><a class="docs-heading-anchor-permalink" href="#Configuration-1" title="Permalink"></a></h2><p>Currently configuration is done via Environment Variables. It is likely to stay that way, as they are also easy to setup in CI tools. You can set these in the <a href="https://docs.julialang.org/en/v1/manual/getting-started/"><code>startup.jl</code></a> file using the <code>ENV</code> dictionary if you don&#39;t want to mess up your <code>.profile</code>. However, most people shouldn&#39;t need to. DataDeps.jl tries to have very sensible defaults.</p><ul><li><code>DATADEPS_ALWAYS_ACCEPT</code> – bypasses the confirmation before downloading data. Set to <code>true</code> (or similar string)<ul><li>default: <code>false</code></li><li>Note that it remains your responsibility to understand and read any terms of the data use (this is remains true even if you don&#39;t turn on this bypass)</li><li>This is provided for scripting (in particular CI) use</li><li>If the <code>CI</code> environment variable is set to true, <code>DATADEPS_ALWAYS_ACCEPT</code>  <strong>must be set</strong> to true or false. This is to prevent hanging in CI.</li></ul></li><li><code>DATADEPS_PROGRESS_UPDATE_PERIOD</code> – how often (in seconds) to print the progress to the log for the download<ul><li>This is used by the default <code>fetch_method</code> and when implementing custom methods it is good to respect it.</li><li>default: <code>5</code> (seconds) usually; <code>Inf</code> (i.e. no updates) if <code>DATADEPS_ALWAYS_ACCEPT</code> is set.</li></ul></li><li><code>DATADEPS_LOAD_PATH</code> – The list of paths to be prepended to the standard load path to save and load data from<ul><li>By default this is empty, but it can be a colon separated list (like most unix path variables). <a href="#The-Load-Path">For more details see above.</a></li></ul></li><li><code>DATADEPS_NO_STANDARD_LOAD_PATH</code> if this is set to <code>true</code> (default <code>false</code>), then the aforementioned list of standard load path files is not included</li><li><code>DATADEPS_DISABLE_DOWNLOAD</code> – causes any action that would result in the download being triggered to throw an exception.<ul><li>useful e.g. if you are in an environment with metered data, where your datasets should have already been downloaded earlier, and if there were not you want to respond to the situation rather than let DataDeps.jl download them for you.</li><li>default <code>false</code></li></ul></li><li><code>DATADEPS_DISABLE_ERROR_CLEANUP</code> – By default DataDeps.jl will cleanup the directory the datadep was being downloaded to if there is an error during the resolution (In any of the <code>fetch</code>, <code>checksum</code>, or <code>post_fetch</code>). For debugging purposes you may wish to disable this cleanup step so you can interrogate the files by hand.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« DataDeps.jl Documentation</a><a class="docs-footer-nextpage" href="../z20-for-pkg-devs/">Usage for developers (including researchers) »</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Tuesday 13 February 2024 03:04">Tuesday 13 February 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>