Metadata-Version: 2.4
Name: icotronic
Version: 3.1.0
Summary: Control and test software for sensory tool holders (STH), sensor milling heads (SMH) and stationary transceiver units (STU)
Author-email: Clemens Burgstaller <burgstaller@ift.at>, Christoph Mayer <mayer@ift.at>, René Schwaiger <rene.schwaiger@ift.at>
Project-URL: Documentation, https://mytoolit.github.io/ICOtronic/
Project-URL: Source, https://github.com/mytoolit/ICOtronic/
Keywords: smart-tool,smh,stu,sth,tool-holder
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: bidict<2,>=0.22.1
Requires-Dist: dynaconf<4,>=3.1.12
Requires-Dist: netaddr<2,>=0.8.0
Requires-Dist: pdfrw<2,>=0.4
Requires-Dist: platformdirs<5,>=3.5.0
Requires-Dist: python-can[pcan]<5,>=4
Requires-Dist: reportlab<5,>=4.0.4
Requires-Dist: tables<4,>=3.10.1
Requires-Dist: tqdm<5,>=4.65
Requires-Dist: semantic_version<3,>=2.10
Provides-Extra: dev
Requires-Dist: coverage>=7.8.2; extra == "dev"
Requires-Dist: pydoclint[flake8]>=0.6.6; extra == "dev"
Requires-Dist: Flake8-pyproject>=1.2.3; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pylint>=3.3.1; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_toggleprompt>=0.6.0; extra == "dev"
Requires-Dist: sphinx-autodoc-typehints>=3; extra == "dev"
Requires-Dist: toml; extra == "dev"
Provides-Extra: test
Requires-Dist: icolyzer>=1.5.0; extra == "test"
Requires-Dist: prysk[pytest-plugin]>=0.15.1; extra == "test"
Requires-Dist: pytest-sphinx; extra == "test"
Requires-Dist: maisie-sphinx-theme>=0.1.2; extra == "test"

[![GitHub Workflow Documentation](https://img.shields.io/github/actions/workflow/status/mytoolit/ICOtronic/documentation.yaml?branch=main&label=Documentation)](https://mytoolit.github.io/ICOtronic/) [![API Documentation](https://img.shields.io/readthedocs/icotronic?label=API%20Documentation)](https://icotronic.readthedocs.io/en/stable/) [![GitHub Workflow Tests](https://img.shields.io/github/actions/workflow/status/mytoolit/ICOtronic/tests.yaml?branch=main&label=Tests)](https://github.com/MyTooliT/ICOtronic/actions/workflows/tests.yaml)

# ICOtronic

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](https://mytoolit.github.io/ICOtronic/).

## 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/ICOtronic/).

You can also download the documentation [under the GitHub Actions tab](https://github.com/MyTooliT/ICOtronic/actions/workflows/documentation.yaml) (just select the latest run and click on the link “ICOtronic 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.
