Metadata-Version: 2.1
Name: geo3d
Version: 0.8.0
Summary: A python package for performing geometric calculations in 3D
Home-page: https://github.com/himbeles/geo3d
Author: himbeles
Author-email: lri@me.com
License: MIT
Description: [![Release on PyPI](https://github.com/himbeles/geo3d/workflows/Publish%20on%20PyPI/badge.svg)](https://pypi.org/project/geo3d/)
        [![Test package](https://github.com/himbeles/geo3d/workflows/Test%20package/badge.svg)](https://github.com/himbeles/geo3d/actions?query=workflow%3A%22Test+package%22)
        
        # geo3d
        
        A python package for performing geometric calculations in 3D.
        It allows to 
          - find coordinate system transformations between frames
          - transform points and vectors
          - express points and vectors in different frames
          - create frames from primary and secondary axes vectors
          - align two point groups by minimizing point-to-point distances
          - fit planes to points
        
        
        ## Installation 
        To install the module and its core requirements, run
        ```sh
        pip install --user -e .
        ```
        within the base directory. 
        
        To install all requirements, including the ones for unit testing and documentation.
        
        ```sh
        pip install --user -e .[dev]
        ```
        
        ## Usage 
        Instructions on basic usage can be found in the jupyter notebook in [`/docs`](./docs), 
        which are also deployed to [himbeles.github.io/geo3d](https://himbeles.github.io/geo3d).
        
        ## Testing
        Unit tests can be run using 
        ```sh
        pytest -s 
        ```
        in package root. 
        
        
        ## Building the docs
        The documentation can be built from the `.ipynb` documents in the `/docs` folder by running
        ```sh
        make html
        ```
        
Keywords: geometry
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: dev
