Skip to content

User Guides #627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EJwalker13 wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

User Guides #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56b11b6
Built User Guides using html, added its hyperlink to the index, and a…
Jan 3, 2025
f080dcd
Adding the user guides HTML to the documentation on CASEI. Removing d…
EJwalker13 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,6 @@ coverage.xml
# Django stuff:
staticfiles/

# Sphinx documentation
docs/_build/

# PyBuilder
target/
Expand Down
Binary file added docs/_build/html/_images/focus.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_build/html/_images/program_info.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
266 changes: 266 additions & 0 deletions docs/_build/html/documentation/api_doc.html
View file
Open in desktop

Large diffs are not rendered by default.

146 changes: 146 additions & 0 deletions docs/_build/html/documentation/casei_overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Catalog of Archived Suborbital Earth Science Investigations &mdash; CASEI 0.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/sphinx-toolbox-code.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="API documentation" href="api_doc.html" />
<link rel="prev" title="admg_webapp Project Documentation" href="../index.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">
CASEI
</a>
<div class="version">
0.1
</div>
<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">
<p class="caption" role="heading"><span class="caption-text">What is CASEI?</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Catalog of Archived Suborbital Earth Science Investigations</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Usage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_doc.html">API documentation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Curation Process</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="curation_interface.html">Curation Interface</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Understanding Application</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="data_models.html">Data Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="change_objects.html">Understanding the Change Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmr_recommender.html">CMR Recommender</a></li>
<li class="toctree-l1"><a class="reference internal" href="gcmd_sync.html">GCMD Sync</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Installation and Tests</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="project_installation.html">Docker Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="running_tests.html">Running Tests</a></li>
</ul>

<p class="caption" role="heading"><span class="caption-text">User Guides</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="user_guides.html">User Guides</a></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">CASEI</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">Catalog of Archived Suborbital Earth Science Investigations</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/documentation/casei_overview.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="catalog-of-archived-suborbital-earth-science-investigations">
<h1>Catalog of Archived Suborbital Earth Science Investigations<a class="headerlink" href="#catalog-of-archived-suborbital-earth-science-investigations" title="Permalink to this heading"></a></h1>
<p>The Catalog of Archived Suborbital Earth Science Investigations (CASEI), is a centralized airborne and field data inventory that streamlines discovery of non-satellite NASA Earth Science data by providing contextual information on events, motivations, and potential data caveats. With CASEI, users can search and browse NASA’s airborne and field data archives, regardless of which data repository (or DAAC) is responsible for their stewardship.</p>
<p>CASEI has two major components. The first is the backend architecture written with Python and comprised of five components:
Django’s models and relational databases
APIs (serializers) to incorporate Common Metadata Repository (CMR) metadata and Airborne Science Program’s (ASP) information. Then returns the database information back to CMR and ASP.
A maintenance interface (MI) for both entering and updating database content
A public user data discovery portal or user interface (UI) for submitting queries with search terms, reviewing information, and accessing data product links</p>
<p>The second part of CASEI is the curation of inventory content. All information in CASEI follows a common data model through a careful curation process along with multiple quality reviews to support the diverse data formats. First a curator compiles suborbital observation metadata for NASA Earth Science products by efficiently categorizing it into campaigns, platforms, and instruments. They follow a structured hierarchy, set of definitions, and decision tree to properly organize this data then submit it for a first and final admin review. All of this effort is conducted through the MI and once it is finally published it’s streamlined into the UI for user access.</p>
<p>Link to CASEI User Interface: <a class="reference external" href="https://impact.earthdata.nasa.gov/casei/">https://impact.earthdata.nasa.gov/casei/</a></p>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="admg_webapp Project Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="api_doc.html" class="btn btn-neutral float-right" title="API documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2019, Carson Davis.</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>
144 changes: 144 additions & 0 deletions docs/_build/html/documentation/change_objects.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Understanding the Change Objects &mdash; CASEI 0.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/sphinx-toolbox-code.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="CMR Recommender" href="cmr_recommender.html" />
<link rel="prev" title="Data Models" href="data_models.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">
CASEI
</a>
<div class="version">
0.1
</div>
<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">
<p class="caption" role="heading"><span class="caption-text">What is CASEI?</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="casei_overview.html">Catalog of Archived Suborbital Earth Science Investigations</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Usage</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_doc.html">API documentation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Curation Process</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="curation_interface.html">Curation Interface</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Understanding Application</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="data_models.html">Data Models</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Understanding the Change Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="cmr_recommender.html">CMR Recommender</a></li>
<li class="toctree-l1"><a class="reference internal" href="gcmd_sync.html">GCMD Sync</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Installation and Tests</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="project_installation.html">Docker Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="running_tests.html">Running Tests</a></li>
</ul>

<p class="caption" role="heading"><span class="caption-text">User Guides</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="user_guides.html">User Guides</a></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">admg_webapp</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">Understanding the Change Objects</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/documentation/change_objects.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="understanding-the-change-objects">
<h1>Understanding the Change Objects<a class="headerlink" href="#understanding-the-change-objects" title="Permalink to this heading"></a></h1>
<a class="reference internal image-reference" href="../_images/1.png"><img alt="" src="../_images/1.png" style="width: 600px;" /></a>
<a class="reference internal image-reference" href="../_images/2.png"><img alt="" src="../_images/2.png" style="width: 600px;" /></a>
<a class="reference internal image-reference" href="../_images/3.png"><img alt="" src="../_images/3.png" style="width: 600px;" /></a>
<a class="reference internal image-reference" href="../_images/4.png"><img alt="" src="../_images/4.png" style="width: 600px;" /></a>
<a class="reference internal image-reference" href="../_images/5.png"><img alt="" src="../_images/5.png" style="width: 600px;" /></a>
<a class="reference internal image-reference" href="../_images/6.png"><img alt="" src="../_images/6.png" style="width: 600px;" /></a>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="data_models.html" class="btn btn-neutral float-left" title="Data Models" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="cmr_recommender.html" class="btn btn-neutral float-right" title="CMR Recommender" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2019, Carson Davis.</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>
Loading
Loading