Metadata-Version: 2.1
Name: icoc
Version: 2.0.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/ICOc/
Project-URL: Source, https://github.com/mytoolit/ICOc/
Keywords: smart-tool,smh,stu,sth,tool-holder
Classifier: Development Status :: 3 - Alpha
Classifier: License :: Other/Proprietary License
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: matplotlib <4,>=3.7.1
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
Requires-Dist: pywin32 >=306 ; os_name == "nt"
Requires-Dist: windows-curses <3,>=2.3.3 ; os_name == "nt"
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: toml ; extra == 'dev'
Provides-Extra: test
Requires-Dist: icolyzer >=1.5.0 ; extra == 'test'
Requires-Dist: prysk[pytest-plugin] >=0.13.1 ; extra == 'test'
Requires-Dist: maisie-sphinx-theme >=0.1.2 ; extra == 'test'

[![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.
