pmac_motorhome

Code CI Docs CI Test Coverage Latest PyPI version Apache License

pmac_motorhome is a python3 tool to generator homing PLCs from a python script

PyPI

pip install pmac_motorhome

Source code

https://github.com/dls-controls/pmac_motorhome

Documentation

https://dls-controls.github.io/pmac_motorhome

This is where you should put some images or code snippets that illustrate some relevant examples. If it is a library then you might put some introductory code here:

from pmac_motorhome.hello import HelloClass

hello = HelloClass("me")
print(hello.format_greeting())

Or if it is a commandline tool then you might put some example commands here:

pmac_motorhome person --times=2

How the documentation is structured

Documentation is split into four categories, accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

How-to Guides

Practical step-by-step guides for the more experienced user.

Explanations

Explanation of how the library works and why it works that way.

Reference

Technical reference material, for classes, methods, APIs, commands, and contributing to the project.

About the documentation

Why is the documentation structured this way?