Merge 87b733c into 63bb93b

.gitignore

@@ -1,3 +1,9 @@
+# IDE ignores
+.vscode/
+
+# Project ignores
+_dev/
+
 # Files generated by invoking Julia with --code-coverage
 *.jl.cov
 *.jl.*.cov

README.md

@@ -4,6 +4,46 @@ A Julia package for optimal estimation algorithms.
 
 Please read the [documentation](https://ap6yc.github.io/OptimalEstimation.jl/dev/) for detailed usage and tutorials.
 
+| **Stable Docs**  | **Dev Docs** | **Testing Status** | **Coverage** |
+|:----------------:|:------------:|:----------------:|:------------:|
+| [![Stable][docs-stable-img]][docs-stable-url] | [![Dev][docs-dev-img]][docs-dev-url]| [![Build Status][ci-img]][ci-url] | [![Codecov][codecov-img]][codecov-url] |
+| **Docs Build** | **JuliaHub Status** | **Dependents** | **Release** |
+| [![Documentation][doc-status-img]][doc-status-url] | [![pkgeval][pkgeval-img]][pkgeval-url] | [![deps][deps-img]][deps-url] | [![version][version-img]][version-url] |
+
+| **Zenodo DOI** |
+| :------------: |
+| [![DOI][zenodo-img]][zenodo-url] |
+
+[zenodo-img]: https://zenodo.org/badge/DOI/10.5281/zenodo.5748453.svg
+[zenodo-url]: https://doi.org/10.5281/zenodo.5748453
+
+[doc-status-img]: https://github.com/AP6YC/OptimalEstimation.jl/actions/workflows/Documentation.yml/badge.svg
+[doc-status-url]: https://github.com/AP6YC/OptimalEstimation.jl/actions/workflows/Documentation.yml
+
+[deps-img]: https://juliahub.com/docs/OptimalEstimation/deps.svg
+[deps-url]: https://juliahub.com/ui/Packages/OptimalEstimation/Sm0We?t=2
+
+[version-img]: https://juliahub.com/docs/OptimalEstimation/version.svg
+[version-url]: https://juliahub.com/ui/Packages/OptimalEstimation/Sm0We
+
+[pkgeval-img]: https://juliahub.com/docs/OptimalEstimation/pkgeval.svg
+[pkgeval-url]: https://juliahub.com/ui/Packages/OptimalEstimation/Sm0We
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://AP6YC.github.io/OptimalEstimation.jl/stable
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://AP6YC.github.io/OptimalEstimation.jl/dev
+
+[ci-img]: https://github.com/AP6YC/OptimalEstimation.jl/workflows/CI/badge.svg
+[ci-url]: https://github.com/AP6YC/OptimalEstimation.jl/actions?query=workflow%3ACI
+
+[codecov-img]: https://codecov.io/gh/AP6YC/OptimalEstimation.jl/branch/main/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/AP6YC/OptimalEstimation.jl
+
+[issues-url]: https://github.com/AP6YC/OptimalEstimation.jl/issues
+[contrib-url]: https://ap6yc.github.io/OptimalEstimation.jl/dev/man/contributing/
+
 ## Contents
 
 - [OptimalEstimation.jl](#optimalestimationjl)

docs/make.jl

@@ -7,10 +7,9 @@ using OptimalEstimation
 # this is the relative path to docs/
 # demopage, postprocess_cb, demo_assets = makedemos("examples")
 
-
-assets = [
-    joinpath("assets", "favicon.ico")
-]
+# assets = [
+#     joinpath("assets", "favicon.ico")
+# ]
 
 # if there are generated css assets, pass it to Documenter.HTML
 # isnothing(demo_assets) || (push!(assets, demo_assets))
@@ -20,7 +19,7 @@ makedocs(
     modules=[OptimalEstimation],
     format=Documenter.HTML(
         prettyurls = get(ENV, "CI", nothing) == "true",
-        assets = assets,
+        # assets = assets,
     ),
     # format=Documenter.HTML(),
     pages=[

docs/src/index.md

@@ -1,7 +1,3 @@
-![header](assets/header.png)
-
----
-
 # OptimalEstimation.jl
 
 These pages serve as the official documentation for the OptimalEstimation.jl Julia package.
@@ -26,8 +22,8 @@ Pages = [
 Depth = 1
 ```
 
-The [Background](@ref) provides an overview of the problem statement of CVIs and what they are theoretically, while [Basic Example](@ref) steps through an single example workflow.
+The [Background](@ref) provides an overview of the problem statement of optimal state estimation.
 
-The [Package Guide](@ref) provides a tutorial to the full usage of the package, while [Examples](@ref examples) gives many sample workflows using a variety of CVI modules.
+The [Package Guide](@ref) provides a tutorial to the full usage of the package, while [Examples](@ref examples) gives many sample workflows using a variety of optimal estimation filters and algorithms.
 
 Instructions on how to contribute to the package are found in [Contributing](@ref), and docstrings for every element of the package is listed in the [Index](@ref main-index).

src/OptimalEstimation.jl

@@ -10,13 +10,25 @@ $(EXPORTS)
 """
 module OptimalEstimation
 
+# --------------------------------------------------------------------------- #
+# USINGS
+# --------------------------------------------------------------------------- #
+
 using DocStringExtensions   # Docstring utilities
 
-"""
+# --------------------------------------------------------------------------- #
+# INCLUDES
+# --------------------------------------------------------------------------- #
 
-"""
-greet() = print("Hello World!")
+include("common.jl")
+include("modules/modules.jl")
+
+# --------------------------------------------------------------------------- #
+# EXPORTS
+# --------------------------------------------------------------------------- #
 
-export greet
+export
+    greet,
+    Filter
 
 end # module

src/common.jl

@@ -0,0 +1,27 @@
+"""
+    common.jl
+
+A collection of common definitions and utilities for the OptimalEstimation.jl package.
+"""
+
+# --------------------------------------------------------------------------- #
+# ABSTRACT TYPES
+# --------------------------------------------------------------------------- #
+
+"""
+    Filter
+
+An abstract type for all filters.
+"""
+abstract type Filter end
+
+# --------------------------------------------------------------------------- #
+# METHODS
+# --------------------------------------------------------------------------- #
+
+"""
+    greet()
+
+Prints a boilerplate hello world for the package.
+"""
+greet() = print("Hello World!")

src/modules/EKF.jl

@@ -0,0 +1,7 @@
+"""
+    EKF.jl
+
+An implementation of an Extended Kalman Filter (EKF).
+"""
+
+# TODO

src/modules/KF.jl

@@ -0,0 +1,7 @@
+"""
+    KF.jl
+
+Implementation of the Kalman Filter (KF).
+"""
+
+# TODO

src/modules/UKF.jl

@@ -0,0 +1,7 @@
+"""
+    UKF.jl
+
+Implementation of the Unscented Kalman Filter (UKF).
+"""
+
+# TODO

src/modules/modules.jl

@@ -0,0 +1,9 @@
+"""
+    modules.jl
+
+This file aggregates all modules in the OptimalEstimation.jl package.
+"""
+
+include("KF.jl")    # Kalman Filter
+include("EKF.jl")   # Extended Kalman Filter
+include("UKF.jl")   # Unscented Kalman Filter