Name | icoc JSON |
Version |
2.0.0
JSON |
| download |
home_page | None |
Summary | Control and test software for sensory tool holders (STH), sensor milling heads (SMH) and stationary transceiver units (STU) |
upload_time | 2024-09-17 14:38:43 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.10 |
license | None |
keywords |
smart-tool
smh
stu
sth
tool-holder
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
[![GitHub Workflow Documentation](https://img.shields.io/github/actions/workflow/status/mytoolit/ICOc/documentation.yaml?branch=main&label=Documentation)](https://mytoolit.github.io/ICOc/) [![API Documentation](https://img.shields.io/readthedocs/icoc?label=API%20Documentation)](https://icoc.readthedocs.io/en/stable/) [![GitHub Workflow Tests](https://img.shields.io/github/actions/workflow/status/mytoolit/ICOc/tests.yaml?branch=main&label=Tests)](https://github.com/MyTooliT/ICOc/actions/workflows/tests.yaml)
# ICOc
This repository contains data collection and test software for the [ICOtronic system](https://www.mytoolit.com/ICOtronic/). For more information, please take a look [at the online documentation of ICOc](https://mytoolit.github.io/ICOc/).
## Documentation
While you should be able to read the [various Markdown files of the documentation](Documentation) separately, we recommend you read the [bookdown](https://bookdown.org) manual instead. We provide a prebuilt version of the documentation [**here**](https://mytoolit.github.io/ICOc/).
You can also download the documentation [under the GitHub Actions tab](https://github.com/MyTooliT/ICOc/actions/workflows/documentation.yaml) (just select the latest run and click on the link “ICOc Manual”).
### Build
If you want to build the documentation yourself, you need the following software:
- [R](https://www.r-project.org),
- [bookdown](https://bookdown.org),
- [make](<https://en.wikipedia.org/wiki/Make_(software)>), and
- (optionally for the PDF version of the manual) the [TinyTeX R package](https://yihui.org/tinytex/).
After you installed the required software you can build the
- HTML (`make html`),
- EPUB (`make epub`), and
- PDF (`make pdf`)
version of the documentation. The output will be stored in the folder `Bookdown` in the root of the repository. If you want to build all versions of the documentation, just use the command
```sh
make doc
```
in the repo root.
Raw data
{
"_id": null,
"home_page": null,
"name": "icoc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "smart-tool, smh, stu, sth, tool-holder",
"author": null,
"author_email": "Clemens Burgstaller <burgstaller@ift.at>, Christoph Mayer <mayer@ift.at>, Ren\u00e9 Schwaiger <rene.schwaiger@ift.at>",
"download_url": "https://files.pythonhosted.org/packages/51/3d/2863dc054453d184467d824f3616a29b82eecb30d3905eb04535613db0e5/icoc-2.0.0.tar.gz",
"platform": null,
"description": "[![GitHub Workflow Documentation](https://img.shields.io/github/actions/workflow/status/mytoolit/ICOc/documentation.yaml?branch=main&label=Documentation)](https://mytoolit.github.io/ICOc/) [![API Documentation](https://img.shields.io/readthedocs/icoc?label=API%20Documentation)](https://icoc.readthedocs.io/en/stable/) [![GitHub Workflow Tests](https://img.shields.io/github/actions/workflow/status/mytoolit/ICOc/tests.yaml?branch=main&label=Tests)](https://github.com/MyTooliT/ICOc/actions/workflows/tests.yaml)\n\n# ICOc\n\nThis repository contains data collection and test software for the [ICOtronic system](https://www.mytoolit.com/ICOtronic/). For more information, please take a look [at the online documentation of ICOc](https://mytoolit.github.io/ICOc/).\n\n## Documentation\n\nWhile you should be able to read the [various Markdown files of the documentation](Documentation) separately, we recommend you read the [bookdown](https://bookdown.org) manual instead. We provide a prebuilt version of the documentation [**here**](https://mytoolit.github.io/ICOc/).\n\nYou can also download the documentation [under the GitHub Actions tab](https://github.com/MyTooliT/ICOc/actions/workflows/documentation.yaml) (just select the latest run and click on the link \u201cICOc Manual\u201d).\n\n### Build\n\nIf you want to build the documentation yourself, you need the following software:\n\n- [R](https://www.r-project.org),\n- [bookdown](https://bookdown.org),\n- [make](<https://en.wikipedia.org/wiki/Make_(software)>), and\n- (optionally for the PDF version of the manual) the [TinyTeX R package](https://yihui.org/tinytex/).\n\nAfter you installed the required software you can build the\n\n- HTML (`make html`),\n- EPUB (`make epub`), and\n- PDF (`make pdf`)\n\nversion of the documentation. The output will be stored in the folder `Bookdown` in the root of the repository. If you want to build all versions of the documentation, just use the command\n\n```sh\nmake doc\n```\n\nin the repo root.\n",
"bugtrack_url": null,
"license": null,
"summary": "Control and test software for sensory tool holders (STH), sensor milling heads (SMH) and stationary transceiver units (STU)",
"version": "2.0.0",
"project_urls": {
"Documentation": "https://mytoolit.github.io/ICOc/",
"Source": "https://github.com/mytoolit/ICOc/"
},
"split_keywords": [
"smart-tool",
" smh",
" stu",
" sth",
" tool-holder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a2389b300733998a7f331e465cb054457094e233598cb046ebb7c7a08c8dec9c",
"md5": "bc9ee81ca7743baed31980ab5ac5764b",
"sha256": "ac3250d4b4e55fc0108d7227cb70343babb9e1aad26acbe55917f8eb193f8215"
},
"downloads": -1,
"filename": "icoc-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc9ee81ca7743baed31980ab5ac5764b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 216051,
"upload_time": "2024-09-17T14:38:41",
"upload_time_iso_8601": "2024-09-17T14:38:41.709934Z",
"url": "https://files.pythonhosted.org/packages/a2/38/9b300733998a7f331e465cb054457094e233598cb046ebb7c7a08c8dec9c/icoc-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "513d2863dc054453d184467d824f3616a29b82eecb30d3905eb04535613db0e5",
"md5": "a74d7a5a492e3aa059c1a52f1f058740",
"sha256": "8aa9925624cd3cd81a038fecd2b27ea247d3a7b28d89b2ff172415ae5b68c63e"
},
"downloads": -1,
"filename": "icoc-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a74d7a5a492e3aa059c1a52f1f058740",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 186339,
"upload_time": "2024-09-17T14:38:43",
"upload_time_iso_8601": "2024-09-17T14:38:43.355234Z",
"url": "https://files.pythonhosted.org/packages/51/3d/2863dc054453d184467d824f3616a29b82eecb30d3905eb04535613db0e5/icoc-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 14:38:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mytoolit",
"github_project": "ICOc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "icoc"
}