Commit 65702c37 authored by Christine Kim's avatar Christine Kim
Browse files

Add docs structure

parent e1e06af9
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
@@ -8,13 +8,13 @@ A library to leverage python wrapped Community Sensor Models (CSMs) for common s

## References:

- CSM (usgscsm): https://github.com/USGS-Astrogeology/usgscsm
- Abstraction Layer for Ephemerides (ALE): https://github.com/USGS-Astrogeology/ale
- CSM (usgscsm): https://github.com/DOI_USGS/usgscsm
- Abstraction Layer for Ephemerides (ALE): https://github.com/DOI_USGS/ale
<hr>

## Overview

We currently use Knoten to help test our supported CSM implementations against well established [ISIS3 camera models](https://github.com/USGS-Astrogeology/ISIS3). In short, The CSM standard, now at version 3.0.3, is a framework that provides a well-defined application program interface (API) for multiple types of sensors and has been widely adopted by remote sensing software systems (e.g. BAE's Socet GXP, Harris Corp.'s ENVI, Hexagon's ERDAS Imagine, and recently added to the NASA AMES Stereo Pipeline [ASP]). Our support for CSM is explained in this [abstract](https://www.hou.usra.edu/meetings/informatics2018/pdf/6040.pdf) and a recently submitted paper (not yet available). Currently, we support **Framing** and **Pushbroom** (line scanner) types of sensor models in the [usgscsm](https://github.com/USGS-Astrogeology/usgscsm) library. 
We currently use Knoten to help test our supported CSM implementations against well established [ISIS3 camera models](https://github.com/DOI_USGS/ISIS3). In short, The CSM standard, now at version 3.0.3, is a framework that provides a well-defined application program interface (API) for multiple types of sensors and has been widely adopted by remote sensing software systems (e.g. BAE's Socet GXP, Harris Corp.'s ENVI, Hexagon's ERDAS Imagine, and recently added to the NASA AMES Stereo Pipeline [ASP]). Our support for CSM is explained in this [abstract](https://www.hou.usra.edu/meetings/informatics2018/pdf/6040.pdf) and a recently submitted paper (not yet available). Currently, we support **Framing** and **Pushbroom** (line scanner) types of sensor models in the [usgscsm](https://github.com/DOI_USGS/usgscsm) library. 

A secondary requirement for our CSM implementation requires an ALE-generated Image Support Data (ISD). ISDs contain the [SPICE-derived](https://naif.jpl.nasa.gov/naif/toolkit.html) positional (and when needed velocity) description for each image. You can find several generated JSON-formatted examples [here](examples/data/)

+7 −0
Original line number Diff line number Diff line
@import 'material_sphinx.css';

.sig.sig-object.py{
    font-feature-settings: "kern";
    font-family: "Roboto Mono", "Courier New", Courier, monospace;
    background: #f8f8f8;
}
 No newline at end of file
+12 −8
Original line number Diff line number Diff line
@@ -10,9 +10,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('..'))


# -- Project information -----------------------------------------------------
@@ -27,8 +27,7 @@ author = 'USGS Astrogeology Software Team'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
]
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -38,6 +37,8 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

autosummary_generate = False
autoclass_content = "class"

# -- Options for HTML output -------------------------------------------------

@@ -46,6 +47,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
#
html_theme = 'sphinx_material'

html_static_path = ['_static']
html_css_files = ['css/custom.css']

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
@@ -81,9 +85,9 @@ html_theme_options = {
    'repo_name': 'Project',

    # Visible levels of the global TOC; -1 means unlimited
    'globaltoc_depth': 3,
    'globaltoc_depth': 2,
    # If False, expand all TOC entries
    'globaltoc_collapse': False,
    'globaltoc_collapse': True,
    # If True, show hidden TOC entries
    'globaltoc_includehidden': False,
}
+11 −0
Original line number Diff line number Diff line
@@ -4,6 +4,17 @@ Knoten
A library to leverage python wrapped Community Sensor Models (CSMs) for common spatial/sensor operations and testing.


Table of Contents
-----------------

:Date: |today|

.. toctree::
   :maxdepth: 2

   library/index
   

References
----------

+9 −0
Original line number Diff line number Diff line
:mod:`bundle` --- Bundle Adjustment
======================================

The :mod:`knoten.bundle` module

.. automodule:: knoten.bundle
  :synopsis:
  :members:
  :show-inheritance:
 No newline at end of file
Loading