-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updating the location of documentation files
- Loading branch information
1 parent
0b477d9
commit 44f0045
Showing
109 changed files
with
10,208 additions
and
1,206 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
213 changes: 213 additions & 0 deletions
213
docs/_autosummary/lexi.lexi.download_files_from_github.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
|
|
||
|
|
||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" data-content_root="../"> | ||
| <head> | ||
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>lexi.lexi.download_files_from_github — LEXI documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> | ||
| <link rel="stylesheet" type="text/css" href="../_static/css/custom.css?v=3be3e096" /> | ||
|
|
||
|
|
||
| <link rel="canonical" href="https://lexi-bu.github.io/_autosummary/lexi.lexi.download_files_from_github.html" /> | ||
| <script src="../_static/jquery.js?v=5d32c60e"></script> | ||
| <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> | ||
| <script src="../_static/documentation_options.js?v=5929fcd5"></script> | ||
| <script src="../_static/doctools.js?v=9bcbadda"></script> | ||
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> | ||
| <script src="../_static/js/theme.js"></script> | ||
| <link rel="index" title="Index" href="../genindex.html" /> | ||
| <link rel="search" title="Search" href="../search.html" /> | ||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav"> | ||
| <div class="wy-grid-for-nav"> | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search" > | ||
|
|
||
|
|
||
|
|
||
| <a href="../index.html" class="icon icon-home"> | ||
| LEXI | ||
| <img src="../_static/lexi_logo.png" class="logo" alt="Logo"/> | ||
| </a> | ||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| </div> | ||
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../install.html">Installation Guide</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="../install.html#creating-a-virtual-environment">Creating a Virtual Environment</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../install.html#using-python3">Using python3</a><ul> | ||
| <li class="toctree-l4"><a class="reference internal" href="../install.html#on-linux-macos">On Linux/MacOS:</a></li> | ||
| <li class="toctree-l4"><a class="reference internal" href="../install.html#on-windows">On Windows:</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../install.html#installing-lexi">Installing Lexi</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../install.html#installing-from-source">Installing from Source</a></li> | ||
| <li class="toctree-l3"><a class="reference internal" href="../install.html#installing-from-a-local-copy">Installing from a Local Copy</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../install.html#verifying-the-installation">Verifying the Installation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="../install.html#using-lexi-software">Using LEXI Software</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="../install.html#using-the-example-jupyter-notebook">Using the Example Jupyter Notebook</a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../modules.html">Functions</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/get_spc_prams/index.html">Get Spacecraft Prams</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/get_spc_prams/index.html#lexi.lexi.get_spc_prams"><code class="docutils literal notranslate"><span class="pre">get_spc_prams()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/download_files_from_github/index.html">Download Files from GitHub</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/download_files_from_github/index.html#lexi.lexi.download_files_from_github"><code class="docutils literal notranslate"><span class="pre">download_files_from_github()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/get_exposure_maps/index.html">Get Exposure Maps</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/get_exposure_maps/index.html#lexi.lexi.get_exposure_maps"><code class="docutils literal notranslate"><span class="pre">get_exposure_maps()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/get_lexi_data/index.html">Get LEXI Data</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/get_lexi_data/index.html#lexi.lexi.get_lexi_data"><code class="docutils literal notranslate"><span class="pre">get_lexi_data()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/get_lexi_images/index.html">Get LEXI Images</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/get_lexi_images/index.html#lexi.lexi.get_lexi_images"><code class="docutils literal notranslate"><span class="pre">get_lexi_images()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/get_sky_backgrounds/index.html">Get Sky Backgrounds</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/get_sky_backgrounds/index.html#lexi.lexi.get_sky_backgrounds"><code class="docutils literal notranslate"><span class="pre">get_sky_backgrounds()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/array_to_image/index.html">Array to Image</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/array_to_image/index.html#lexi.lexi.array_to_image"><code class="docutils literal notranslate"><span class="pre">array_to_image()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/validate_input/index.html">Validate Input</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/validate_input/index.html#lexi.lexi.validate_input"><code class="docutils literal notranslate"><span class="pre">validate_input()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="../rst_files/vignette/index.html">Vignette</a><ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="../rst_files/vignette/index.html#lexi.lexi.vignette"><code class="docutils literal notranslate"><span class="pre">vignette()</span></code></a></li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
|
|
||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="../index.html">LEXI</a> | ||
| </nav> | ||
|
|
||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"> | ||
| <div role="navigation" aria-label="Page navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> | ||
| <li class="breadcrumb-item active">lexi.lexi.download_files_from_github</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="https://github.com/Lexi-BU/lexi/blob/stable/docs/_autosummary/lexi.lexi.download_files_from_github.rst" class="fa fa-github"> Edit on GitHub</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <section id="lexi-lexi-download-files-from-github"> | ||
| <h1>lexi.lexi.download_files_from_github<a class="headerlink" href="#lexi-lexi-download-files-from-github" title="Link to this heading"></a></h1> | ||
| <dl class="py function"> | ||
| <dt class="sig sig-object py" id="lexi.lexi.download_files_from_github"> | ||
| <span class="sig-prename descclassname"><span class="pre">lexi.lexi.</span></span><span class="sig-name descname"><span class="pre">download_files_from_github</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_name_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">repo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">branch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'main'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'downloaded_data'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#lexi.lexi.download_files_from_github" title="Link to this definition"></a></dt> | ||
| <dd><p>Function to download files from a GitHub repository. Eventually, this function will be removed | ||
| and we will be able to use the <cite>get_lexi_data</cite> function to download the files directly from the | ||
| CDAweb website. For now, we will use this function to download the files from the GitHub to be | ||
| used as a placeholder until we have the real data hosted on the appropriate website.</p> | ||
| <p>NOTE: In this function, we are using two folders to store and download the files. The first | ||
| folder contains the first 950 files, and the second folder contains the remaining files. The | ||
| reason for this is that the GitHub API only returns a maximum of 1000 files per request. If the | ||
| folder contains more than 1000 files, then the files are split into multiple folders. The folder | ||
| names are as follows: files_0_to_950, files_950_to_1917. The folder names are hardcoded in the | ||
| function.</p> | ||
| <section id="parameters"> | ||
| <h2>Parameters<a class="headerlink" href="#parameters" title="Link to this heading"></a></h2> | ||
| <dl class="simple"> | ||
| <dt>file_name_list<span class="classifier">list</span></dt><dd><p>List of file names to download</p> | ||
| </dd> | ||
| <dt>repo<span class="classifier">str</span></dt><dd><p>Name of the GitHub repository</p> | ||
| </dd> | ||
| <dt>folder_path<span class="classifier">str</span></dt><dd><p>Path to the folder in the GitHub repository</p> | ||
| </dd> | ||
| <dt>branch<span class="classifier">str, optional</span></dt><dd><p>Name of the branch in the GitHub repository. Default is “main”</p> | ||
| </dd> | ||
| <dt>save_dir<span class="classifier">str, optional</span></dt><dd><p>Directory to save the downloaded files. Default is “downloaded_data”</p> | ||
| </dd> | ||
| <dt>verbose<span class="classifier">bool, optional</span></dt><dd><p>If True, print messages. Default is False</p> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| <section id="returns"> | ||
| <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading"></a></h2> | ||
| <dl class="simple"> | ||
| <dt>local_file_list<span class="classifier">list</span></dt><dd><p>List of local file paths</p> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| <section id="raises"> | ||
| <h2>Raises<a class="headerlink" href="#raises" title="Link to this heading"></a></h2> | ||
| <dl class="simple"> | ||
| <dt>ValueError</dt><dd><p>If the status code of the response is not 200</p> | ||
| </dd> | ||
| </dl> | ||
| </section> | ||
| </dd></dl> | ||
|
|
||
| </section> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright LEXI Team @ Boston University, 2024.</p> | ||
| </div> | ||
|
|
||
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | ||
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | ||
| provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
|
|
||
|
|
||
| </footer> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| <script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.