| Name | ellipsetools JSON |
| Version |
0.0.5
JSON |
| download |
| home_page | |
| Summary | Equal subdivision of an ellipse into N points |
| upload_time | 2022-12-12 00:51:20 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) 2022 Philip Nielsen 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 |
arc length
ellipse
perimeter
subdivision
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ellipsetools
This package provides a few convinient tools for ellipses. The main takeaway is the ability to subdivide an
ellipse. Specifically, it can generate $N$ points on an ellipse, with axes $(a, b)$,
where the arc length between each point is identical. Refer to the *Usage* section to see an example of this.
The total arc length of the ellipse is solved (numerically) by the integral
Using the above, we split the task into $N$ optimization problems to find coordinates of each segment.
The program is reasonably fast and can easily generate more than $N = 1000$ points.
## Installation
The package is available on `PyPI`. You can install using the command below.
```
pip install ellipsetools
```
## Usage
An example of a command-line program is given in `examples/cnc_drill_holes.py`. It creates coordiates
for hole-drilling on an elliptical shape for CNC machines. In such cases, it is paramount that each hole
has equal spacing.
Running the program produces the following ellipse:
From the above, it is clear that the holes are evenly spaced. Blue points indicate holes, whereas the
orange curve is the shape of the body which is to be drilled by the CNC machine.
Raw data
{
"_id": null,
"home_page": "",
"name": "ellipsetools",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "arc length,ellipse,perimeter,subdivision",
"author": "",
"author_email": "Philip Nielsen <philiptofte@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/80/6e/331d8adcb1b717cb703868ff2702bc6339bee21e319b99698ca71c4a3814/ellipsetools-0.0.5.tar.gz",
"platform": null,
"description": "# ellipsetools\nThis package provides a few convinient tools for ellipses. The main takeaway is the ability to subdivide an\nellipse. Specifically, it can generate $N$ points on an ellipse, with axes $(a, b)$,\nwhere the arc length between each point is identical. Refer to the *Usage* section to see an example of this.\nThe total arc length of the ellipse is solved (numerically) by the integral\n\n\n\nUsing the above, we split the task into $N$ optimization problems to find coordinates of each segment.\nThe program is reasonably fast and can easily generate more than $N = 1000$ points.\n\n## Installation\nThe package is available on `PyPI`. You can install using the command below.\n```\npip install ellipsetools\n```\n\n## Usage\nAn example of a command-line program is given in `examples/cnc_drill_holes.py`. It creates coordiates\nfor hole-drilling on an elliptical shape for CNC machines. In such cases, it is paramount that each hole\nhas equal spacing.\n\nRunning the program produces the following ellipse:\n\nFrom the above, it is clear that the holes are evenly spaced. Blue points indicate holes, whereas the\norange curve is the shape of the body which is to be drilled by the CNC machine.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2022 Philip Nielsen 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": "Equal subdivision of an ellipse into N points",
"version": "0.0.5",
"split_keywords": [
"arc length",
"ellipse",
"perimeter",
"subdivision"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e8fb6151967a011b408c989441c60cc8",
"sha256": "0fbb1d047fddee85149769f2df72d779379a55df534af25f6b8a2c7a3beade76"
},
"downloads": -1,
"filename": "ellipsetools-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8fb6151967a011b408c989441c60cc8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5285,
"upload_time": "2022-12-12T00:51:18",
"upload_time_iso_8601": "2022-12-12T00:51:18.416953Z",
"url": "https://files.pythonhosted.org/packages/0a/21/95c56e6b6dbe5db8a315e85c1bb3b49b9d415c6ded9807aca5f66778b0c4/ellipsetools-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "f1493c0fc5ad0159ed4e3fb3975f6d2d",
"sha256": "e5e11a8241d44b5f16a79e4f7125af1f23e56b0b267f1dcb8fa7cd2f10cb35bb"
},
"downloads": -1,
"filename": "ellipsetools-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "f1493c0fc5ad0159ed4e3fb3975f6d2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 35331,
"upload_time": "2022-12-12T00:51:20",
"upload_time_iso_8601": "2022-12-12T00:51:20.556271Z",
"url": "https://files.pythonhosted.org/packages/80/6e/331d8adcb1b717cb703868ff2702bc6339bee21e319b99698ca71c4a3814/ellipsetools-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-12 00:51:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "ellipsetools"
}
