Metadata-Version: 2.1
Name: geo3d
Version: 0.4.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
Keywords: geometry
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy (>=1.14)
Requires-Dist: scipy (>=1.2.1)
Requires-Dist: numba
Provides-Extra: dev
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'dev'
Requires-Dist: sphinx-bootstrap-theme ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: setuptools-scm ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'

[![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, such as 
  - coordinate system transformations
  - rigid body motion under local constraints


## 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 

### Basic usage
Instructions on basic usage can be found in the jupyter notebook
`examples/basic_usage.ipynb`.

### Constrained motion
The module allows to calculate rigid body movement from disturbances to exact constraints. 
A usage example is given in
`examples/constrained_motion.ipynb`.

## Testing
Unit tests can be run using 
```sh
pytest -s 
```
in package root. 


