OptimalEstimation.jl

A Julia package for optimal estimation algorithms.

Please read the documentation for detailed usage and tutorials.

Stable Docs	Dev Docs	Testing Status	Coverage
Docs Build	JuliaHub Status	Dependents	Release

Zenodo DOI

Contents

• OptimalEstimation.jl
  • Contents
  • Overview
  • Contributing
  • Installation
  • Quickstart
  • Implemented Modules
  • Structure
  • History
  • Acknowledgements
    • Authors
    • Related Projects
  • License

Overview

TODO

Contributing

If you have a question or concern, please raise an issue. For more details on how to work with the project, propose changes, or even contribute code, please see the Developer Notes in the project's documentation.

In summary:

1. Questions and requested changes should all be made in the issues page. These are preferred because they are publicly viewable and could assist or educate others with similar issues or questions.
2. For changes, this project accepts pull requests (PRs) from feature/<my-feature> branches onto the develop branch using the GitFlow methodology. If unit tests pass and the changes are beneficial, these PRs are merged into develop and eventually folded into versioned releases.
3. The project follows the Semantic Versioning convention of major.minor.patch incremental versioning numbers. Patch versions are for bug fixes, minor versions are for backward-compatible changes, and major versions are for new and incompatible usage changes.

Installation

This project is distributed as a Julia package, available on JuliaHub. Its usage follows the usual Julia package installation procedure, interactively:

] add OptimalEstimation

or programmatically:

using Pkg
Pkg.add("OptimalEstimation")

You may also add the package directly from GitHub to get the latest changes between releases:

] add https://github.com/AP6YC/OptimalEstimation.jl

Quickstart

After installation, load the module with

using OptimalEstimation

Implemented Modules

TODO

Structure

The following file tree summarizes the project structure:

OptimalEstimation
├── .github/workflows       // GitHub: workflows for testing and documentation.
├── docs                    // Docs: documentation for the module.
│   ├─── examples           //      DemoCards documentation examples.
│   └─── src                //      Documentation source files.
├── src                     // Source: majority of source code.
├── test                    // Test: Unit, integration, and environment tests.
├── .gitignore              // Git: .gitignore for the whole project.
├── LICENSE                 // Doc: the license to the project.
├── Project.toml            // Julia: the Pkg.jl dependencies of the project.
└── README.md               // Doc: this document.

History

• 6/24/2022 - Begin project.
• 9/29/2022 - Submit to JuliaHub

Acknowledgements

Authors

This package is developed and maintained by Sasha Petrenko with sponsorship by the Applied Computational Intelligence Laboratory (ACIL). This project is supported by grants from the Night Vision Electronic Sensors Directorate, the DARPA Lifelong Learning Machines (L2M) program, Teledyne Technologies, and the National Science Foundation. The material, findings, and conclusions here do not necessarily reflect the views of these entities.

Related Projects

If this package does not suit your needs in some way, below is a list of related projects implementing filters of various kinds:

• https://github.com/sisl/GaussianFilters.jl
• https://github.com/JuliaGNSS/KalmanFilters.jl

License

This software is openly maintained by the ACIL of the Missouri University of Science and Technology under the MIT License.