Skip to content

Commit

Permalink
Merge pull request #272 from bsipocz/BUG_fix_duplicated_documentation
Browse files Browse the repository at this point in the history
BUG: remove duplicated documentation section af6f7c4
  • Loading branch information
bsipocz committed Apr 15, 2024
1 parent 71f34aa commit 3e996cd
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 38 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
8 changes: 1 addition & 7 deletions _sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,7 @@ light_curves/README
```


% Including the main repo README as is

```{include} README.md
```

## Documentation
## User Documentation

```{toctree}
---
Expand Down
34 changes: 4 additions & 30 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -406,10 +406,7 @@ <h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#executive-summary">Executive Summary</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#documentation">Documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#content-contributing">Content contributing</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#user-documentation">User Documentation</a></li>
</ul>
</nav>
</div>
Expand Down Expand Up @@ -438,28 +435,8 @@ <h1>Tutorial Notebooks<a class="headerlink" href="#tutorial-notebooks" title="Li
</li>
</ul>
</div>
<section id="executive-summary">
<h2>Executive Summary<a class="headerlink" href="#executive-summary" title="Link to this heading">#</a></h2>
<p>The Fornax Initiative is a NASA Astrophysics Archives project to collaboratively among the three archives HEASARC, IRSA, and MAST, create cloud systems, cloud software, and cloud standards for the astronomical community.</p>
<p>The Fornax Science Console is a cloud compute system near to NASA data in the AWS cloud which provides a place where astronomers can do data-intensive research with reduced barriers. The Fornax Initiative provides increased compute, increased memory, increased ease of use by pre-installing astronomical software, increased reproducibility of big data results, and increased inclusion by removing some of these barriers to entry, tutorial notebooks, and documentation.</p>
<p>This repo houses tutorial notebooks of fully worked science use cases for all users. Common goals of the notebooks are the usage of archival data from all NASA archives, cross-archive work, big data, and computationally intensive science. Currently, there are two major topics for which we have notebooks. The “Photometry” notebook starts with a catalog and a set of archival images. The notebook grabs all necessary images and measures photometry at all positions listed in the catalog on all images. The “Time Domain” notebooks are twofold. The first generates light curves from all available archival data for any user-supplied sample of targets. The second notebook runs ML algorithms to classify those generated light curves.</p>
</section>
<section id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">#</a></h2>
<p>The user cases and documentation of the Fornax Initiative are currently available at the https://fornax-navo.github.io/fornax-demo-notebooks/ URL.</p>
</section>
<section id="content-contributing">
<h2>Content contributing<a class="headerlink" href="#content-contributing" title="Link to this heading">#</a></h2>
<p>In this repository, we follow the standard practice of the Scientific Python ecosystem and use Jupytext and MyST Markdown Notebooks.
You will need <code class="docutils literal notranslate"><span class="pre">jupytext</span></code> installed for your browser to recognise the markdown files as notebooks (see more about the motivation and technicalities e.g. here: https://numpy.org/numpy-tutorials/content/pairing.html).</p>
<p>If you already have an <code class="docutils literal notranslate"><span class="pre">ipynb</span></code> file, convert it to Markdown using the following command, and commit
only the markdown file to the repo:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">jupytext</span> <span class="o">--</span><span class="kn">from</span> <span class="nn">notebook</span> <span class="o">--</span><span class="n">to</span> <span class="n">myst</span> <span class="n">yournotebook</span><span class="o">.</span><span class="n">ipynb</span>
</pre></div>
</div>
</section>
<section id="id1">
<h2>Documentation<a class="headerlink" href="#id1" title="Link to this heading">#</a></h2>
<section id="user-documentation">
<h2>User Documentation<a class="headerlink" href="#user-documentation" title="Link to this heading">#</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="documentation/README.html">Fornax Science Console</a><ul>
Expand Down Expand Up @@ -517,10 +494,7 @@ <h2>Documentation<a class="headerlink" href="#id1" title="Link to this heading">
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#executive-summary">Executive Summary</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#documentation">Documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#content-contributing">Content contributing</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Documentation</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#user-documentation">User Documentation</a></li>
</ul>
</nav></div>

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 3e996cd

Please sign in to comment.