geo3d


Namegeo3d JSON
Version 1.3.0 PyPI version JSON
download
home_pageNone
SummaryA python package for performing geometric calculations in 3D
upload_time2024-04-27 07:43:19
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT License Copyright (c) 2019 Luis Riegger Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords geometry
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![pypi](https://img.shields.io/pypi/v/geo3d.svg)](https://pypi.python.org/pypi/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

Requires Python 3.7 or up .

## Installation

To install the module and its core requirements, run
```sh
pip install geo3d
```

Maintainers should install in editable mode, including all additional requirements for unit testing and documentation:

```sh
pip install -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.

If a coverage report should be generated, run 
```sh
python -m coverage run -m pytest
```


## Building the docs
The documentation can be built from the `.ipynb` documents in the `/docs` folder by running
```sh
make html
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "geo3d",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "geometry",
    "author": null,
    "author_email": "\"L. Riegger\" <lri@me.com>",
    "download_url": "https://files.pythonhosted.org/packages/cb/bc/083a7c6c2e11154205cdf23c2a0cedd6113efb815083e4e01773a391cfca/geo3d-1.3.0.tar.gz",
    "platform": null,
    "description": "[![pypi](https://img.shields.io/pypi/v/geo3d.svg)](https://pypi.python.org/pypi/geo3d)\n[![Test package](https://github.com/himbeles/geo3d/workflows/Test%20package/badge.svg)](https://github.com/himbeles/geo3d/actions?query=workflow%3A%22Test+package%22)\n\n# geo3d\n\nA python package for performing geometric calculations in 3D.\nIt allows to \n  - find coordinate system transformations between frames\n  - transform points and vectors\n  - express points and vectors in different frames\n  - create frames from primary and secondary axes vectors\n  - align two point groups by minimizing point-to-point distances\n  - fit planes to points\n\nRequires Python 3.7 or up .\n\n## Installation\n\nTo install the module and its core requirements, run\n```sh\npip install geo3d\n```\n\nMaintainers should install in editable mode, including all additional requirements for unit testing and documentation:\n\n```sh\npip install -e .[dev]\n```\n\n## Usage \nInstructions on basic usage can be found in the jupyter notebook in [`/docs`](./docs), \nwhich are also deployed to [himbeles.github.io/geo3d](https://himbeles.github.io/geo3d).\n\n## Testing\nUnit tests can be run using \n```sh\npytest -s \n```\nin package root.\n\nIf a coverage report should be generated, run \n```sh\npython -m coverage run -m pytest\n```\n\n\n## Building the docs\nThe documentation can be built from the `.ipynb` documents in the `/docs` folder by running\n```sh\nmake html\n```\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019 Luis Riegger  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A python package for performing geometric calculations in 3D",
    "version": "1.3.0",
    "project_urls": {
        "Documentation": "https://himbeles.github.io/geo3d/",
        "Homepage": "https://github.com/himbeles/geo3d",
        "Repository": "https://github.com/himbeles/geo3d.git"
    },
    "split_keywords": [
        "geometry"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1edf5f2b8f7159347ab99aa8ef5e371aadda04d31ae4705698fdb249b1c8d2aa",
                "md5": "df122e1873416ab2156d30f5764c4aa6",
                "sha256": "1d37d7897a0ecbfbf997a1ba20fc1bf48bed7b8a565fbf662e1afd911571a26f"
            },
            "downloads": -1,
            "filename": "geo3d-1.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "df122e1873416ab2156d30f5764c4aa6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 19553,
            "upload_time": "2024-04-27T07:43:13",
            "upload_time_iso_8601": "2024-04-27T07:43:13.033444Z",
            "url": "https://files.pythonhosted.org/packages/1e/df/5f2b8f7159347ab99aa8ef5e371aadda04d31ae4705698fdb249b1c8d2aa/geo3d-1.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cbbc083a7c6c2e11154205cdf23c2a0cedd6113efb815083e4e01773a391cfca",
                "md5": "eca05e4d732599d191b658ff2182245f",
                "sha256": "f03555b97251f5ee952628b2576257657bda32026c0f5b928f5c3bc812e34ad5"
            },
            "downloads": -1,
            "filename": "geo3d-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "eca05e4d732599d191b658ff2182245f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 29970,
            "upload_time": "2024-04-27T07:43:19",
            "upload_time_iso_8601": "2024-04-27T07:43:19.914450Z",
            "url": "https://files.pythonhosted.org/packages/cb/bc/083a7c6c2e11154205cdf23c2a0cedd6113efb815083e4e01773a391cfca/geo3d-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-27 07:43:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "himbeles",
    "github_project": "geo3d",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "geo3d"
}
        
Elapsed time: 1.41117s