Skip to main content

Rational Linkages

Project description

build Documentation Status PyPI version coverage GitHub issues Python Binder

Rational Linkages

Python-based package for synthesis and rapid-prototyping of rational linkages, developed by the Unit of Geometry and Surveying, University of Innsbruck, Austria. The documentation with examples is hosted on Read the Docs, available here: Rational Linkages Documentation.

Intallation instuctions

Recommended Python version is 3.11, when it provides the smoothest plotting (but 3.10 or higher are supported). Python 3.11 is also the version used for development.

Install from PyPI

Using pip:

pip install rational-linkages

Install from source

  1. Clone the repository (use preferably your client, or clone with the button on top of this page or using the following line)

    git clone https://git.uibk.ac.at/geometrie-vermessung/rational-linkages.git

  2. Navigate to the repository folder

    cd rational-linkages

  3. Install the editable version of the package using pip:

    pip install -e .

Tutorials, issues, usage, and contributions

See the documentation examples for tutorials and usage examples.

Since the self-hosted repository does not allow external users to create issues, please, use the external issue tracker hosted on GitHub for submitting issues and feature requests. Additionally, you can "watch/star" the issue tracker package to get notified about the updates (new releases will be also announced there).

You can test live-example of Jupyter notebook using Binder, by clicking on the following badge: Binder

In case of other questions or contributions, please, email the author at: daniel.huczala@uibk.ac.at

Preprint and citing the package

For additional information, see our preprint paper, and in the case of usage, please, cite it:

Huczala, D., Siegele J., Thimm, D., Pfurner, M., Schröcker, H.-P. (2024). Rational Linkages: From Poses to 3D-printed Prototypes. Advances in Robot Kinematics 2024. ARK 2024. Preprint arXiv:2403.00558, url: https://arxiv.org/abs/2403.00558.

@inbook{huczala2024linkages,
    title={Rational Linkages: From Poses to 3D-printed Prototypes},
    author={Daniel Huczala and Johannes Siegele and Daren A. Thimm and Martin Pfurner and Hans-Peter Schröcker},
    year={2024},
    booktitle="Advances in Robot Kinematics 2024, ARK 2024",
    url={https://arxiv.org/abs/2403.00558}
}

Acknowledgements

Funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Research Executive Agency (REA). Neither the European Union nor the granting authority can be held responsible for them.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rational_linkages-1.5.0.tar.gz (130.5 kB view hashes)

Uploaded Source

Built Distribution

rational_linkages-1.5.0-py3-none-any.whl (126.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page