All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Added pyproject.toml file to replace the deprecated setup.py
- Added version to main package init.py file
- Moved from the setuptools to hatchling build backend
- Docutils version will now be installed by Sphinx
- Changed the docs/conf.py to get its version from the package import
- Updated documentation for the new hatch workflow
- Removed old requirements.txt
- Removed requirements.txt from docs
- Removed tools folder for version management. Check pyproject.toml
- Error raise if geomagnetic field is invalid in class
EKF
. - New method
Omega
in classAQUA
to simplify the product between angular rate and quaternion. - New method
rotate_by
in classQuaternionArray
. - More Acronyms in page
Nomeclature
of documentation. - Individual pages for each method and attribute of classes
Quaternion
andDCM
into documentation. - Merge pull request of basic automation tests.
- Fix undefined matrix
R
in methodupdate
of classEKF
. - Fix shape of converted points in function
ned2enu
. - Fix parameters in function
rec2geo
of submoduleframes
. - Fix method
from_quaternion
of classDCM
. - Fix Munich height (in km) in global constants.
- Improve detection of empty arrays when building
TRIAD
object. - Improve description of estimator
AQUA
in its docstring. - Improve imports in submodules
frames
anddcm
. - Improve style and descriptions in docstrings of functions in submodule
orientation
. - Method
init_q
is now synonym of the more convenient methodestimate
in classAQUA
. - Parameter
as_quaternion
in methodestimate
of classTRIAD
renamed torepresentation
, and its value is now of typestr
. - Versioning is defined using f-strings.
- Redundant normalization of magnetic measurement vector in class
FQA
.
- World Magnetic Model as class
WMM
. - World Geodetic System as class
WGS
. - Geodetic and planetary constants.
- New class
DCM
to represent Direction Cosine Matrices. - Attitude Estimator
EKF
. - Attitude Estimator
TRIAD
. - Attitude Estimator
Davenport
. - Attitude Estimator
QUEST
. - Attitude Estimator
SAAM
. - Attitude Estimator
OLEQ
. - Attitude Estimator
ROLEQ
. - Implementation of modes
newton
,eig
andsymbolic
in estimatorFLAE
. - New function
ecompass
to estimate Orientation from an observation of an accelerometer and a magnetometer. - New method
row_reduction
in estimatorFLAE
. - New methods
to_angles
,is_pure
,is_real
,is_versor
, andis_identity
in classQuaternionArray
. - New properties
logarithm
andlog
in classQuaternion
. - New parameter
versor
defaulting toTrue
in classQuaternion
to initialize quaternions as versors. - New frame transformations
ned2enu
,enu2ned
,ecef2enu
,enu2ecef
,ll2ecef
, andecef2llf
. - Requirements file.
- Manifest file.
- Documentation with Sphinx.
- Type hints.
- Fix
AQUA
. - Fix missing imports in several submodules.
- Fix versioning that prevented install from a fresh setup.
Tilt
can perform vectorized estimations over 2D arrays.QuaternionArray
is now subclassed from anumpy.array
.- Simplify implementation of class
Complementary
. - Create copies of quaternions and normalize them when given in
metrics
functions. - Complete attitude estimator
FAMC
. - Complete docstrings of all functions, methods and classes.
- Improve examples and information in
README
.
- Submodules
plot
andio
to remove dependencies onscipy
andmatplotlib
.
- Support for other characters as separators in function
load
of submoduleio
. - Function
am2euler
to obtain Euler angles from gravity and geomagnetic measurements. - Notice of discontinuation of
io
andplotting
submodules. - Add badge of code quality.
- Using
isinstance(x, y)
instead oftype(x)==y
to confirm types of variables. - Update setup information.
- This changelog.
- Script
triad.py
for future submodule implementation of TRIAD method.
- Action
Build Python Package
builds only when new commit is pushed tomaster
branch. - Simplify building triads in function
triad
of submoduleorientation
. - Fix documentation of
am2angles
andquest
of submoduleorientation
.
- Class
QuaternionArray
to handle several quaternions at once. - Add methods
log()
,exp()
,inv()
,to_array()
andto_list()
to classQuaternion
.
- Class
Quaternion
to handle quaternion operations. - Add methods
log()
,exp()
,inv()
,to_array()
andto_list()
to classQuaternion
. - More definitions of colors with formats ints and floats.
- Functions
hex_to_int()
andhex_to_float()
convert any color defined as hex intoint
andfloat
. - Badges in README to indicate basic information.
- Improve versioning.
- Function
R2q()
to get quaternion from rotation matrix. Methodfrom_DCM()
of classQuaternion
is preferred.