Metadata-Version: 2.1
Name: alitra
Version: 1.0.9
Summary: Simple alignment and transformation between coordinate frames
Home-page: https://github.com/equinor/alitra
Author: Equinor ASA
Author-email: arnts@equinor.com, euel@equinor.com, chjo@equinor.com
License: MIT
Description: # Alitra
        
        WIP Library for ALIgnment and TRAnsformation between fixed coordinate frames. The transform
        is described by a translation and a homogeneous rotation.
        
        Developed for transforming between the fixed local coordinate-frame and the asset-fixed
        coordinate-frame.
        
        ## Installation
        
        ### Installation from pip
        
        ```
        pip install alitra
        ```
        
        ```python
        import alitra
        help(alitra)
        ```
        
        ### Installation from source
        
        ```
        pip install .
        ```
        
        You can test whether installation was successfull with pytest
        
        ```
        pip install pytest
        pytest .
        ```
        
        ### Local development
        
        ```
        pip install -e /path/to/package
        ```
        
        This will install package in _editable_ mode. Convenient for local development
        
        ## Components
        
        ### Frame transform
        
        Class for transforming coordinates between two coordinates frames. Use custom
        dataclasses for conveniency, and to ensure that no mistakes are made in the transform.
        
        ### Align frames
        
        Finds the rotations and translations between two coordinate systems by minimizing the
        matching error given a set of points described in both coordinate frames.
        Run `python examples/example_manual_alignment.py` for a demonstration of its use.
        
Platform: UNKNOWN
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Description-Content-Type: text/markdown
