https://github.com/andreablengino/gearpy

Python library for powertrain analysis
https://github.com/andreablengino/gearpy

engineering gearbox gears mechanics motor powertrain

Last synced: 14 days ago
JSON representation

Python library for powertrain analysis

• Host: GitHub
• URL: https://github.com/andreablengino/gearpy
• Owner: AndreaBlengino
• License: gpl-3.0
• Created: 2023-09-23T15:41:02.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-13T15:28:05.000Z (7 months ago)
• Last Synced: 2024-04-14T04:24:25.363Z (7 months ago)
• Topics: engineering, gearbox, gears, mechanics, motor, powertrain
• Language: Python
• Homepage: https://pypi.org/project/gearpy/
• Size: 6.37 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: https://github.com/AndreaBlengino/gearpy/blob/master/docs/source/_static/logo.png?raw=true

  :alt: Logo

Powertrain Analysis

-------------------

**gearpy** is a python library for powertrain analysis.

.. list-table::

   :stub-columns: 1

   :widths: auto

   :width: 100%

   * - PyPI

     - |pypi_release| |supported_python_versions| |build| |dependencies|

   * - Tests

     - |linux_tests| |macos_tests| |windows_tests| |test_coverage|

   * - Documentation

     - |docs|

   * - Code Quality

     - |codefactor_grade| |codacy_grade| |issues|

   * - License

     - |license|

.. |pypi_release| image:: https://img.shields.io/pypi/v/gearpy?label=release&color=blue

   :target: https://pypi.org/project/gearpy/

   :alt: PyPI - Library Version

.. |supported_python_versions| image:: https://img.shields.io/pypi/pyversions/gearpy?logo=python&logoColor=gold

   :target: https://pypi.org/project/gearpy/

   :alt: PyPI - Supported Python Versions

.. |build| image:: https://img.shields.io/github/actions/workflow/status/AndreaBlengino/gearpy/release.yml.svg?logo=github

   :target: https://github.com/AndreaBlengino/gearpy/actions/workflows/release.yml

   :alt: Package Build

.. |dependencies| image:: https://dependency-dash.repo-helper.uk/github/AndreaBlengino/gearpy/badge.svg

   :target: https://dependency-dash.repo-helper.uk/github/AndreaBlengino/gearpy

   :alt: Dependencies Status

.. |linux_tests| image:: https://img.shields.io/github/actions/workflow/status/AndreaBlengino/gearpy/linux_test.yml.svg?logo=linux&logoColor=white&label=Linux

   :target: https://github.com/AndreaBlengino/gearpy/actions/workflows/linux_test.yml

   :alt: Linux Tests

.. |macos_tests| image:: https://img.shields.io/github/actions/workflow/status/AndreaBlengino/gearpy/macos_test.yml.svg?logo=apple&label=macOS

   :target: https://github.com/AndreaBlengino/gearpy/actions/workflows/macos_test.yml

   :alt: macOS Tests

.. |windows_tests| image:: https://img.shields.io/github/actions/workflow/status/AndreaBlengino/gearpy/windows_test.yml.svg?logo=windows&label=Windows

   :target: https://github.com/AndreaBlengino/gearpy/actions/workflows/windows_test.yml

   :alt: Windows Tests

.. |test_coverage| image:: https://img.shields.io/codecov/c/github/AndreaBlengino/gearpy/master?logo=codecov

   :target: https://codecov.io/gh/AndreaBlengino/gearpy

   :alt: Test Coverage

.. |docs| image:: https://img.shields.io/readthedocs/gearpy/latest?logo=read%20the%20docs

   :target: https://gearpy.readthedocs.io/en/latest/?badge=latest

   :alt: Documentation Build Status

.. |codefactor_grade| image:: https://img.shields.io/codefactor/grade/github/AndreaBlengino/gearpy?logo=codefactor&label=CodeFactor

   :target: https://www.codefactor.io/repository/github/andreablengino/gearpy

   :alt: CodeFactor Grade

.. |codacy_grade| image:: https://img.shields.io/codacy/grade/132c2f3d93344ae0934ea808bbf17f05?logo=codacy&label=Codacy

   :target: https://app.codacy.com/gh/AndreaBlengino/gearpy/dashboard

   :alt: Codacy Grade

.. |issues| image:: https://img.shields.io/github/issues/AndreaBlengino/gearpy?logo=github

   :target: https://github.com/AndreaBlengino/gearpy/issues

   :alt: Open Issues

.. |license| image:: https://img.shields.io/badge/License-GPLv3-blue.svg

   :target: https://github.com/AndreaBlengino/gearpy/blob/master/LICENSE

   :alt: License

References

----------

- `Installation `_

- `PyPI `_

- `Documentation `_

- `Usage examples `_

- `Issue tracker `_

- `Source code `_

- `GNU General Public License v3.0 `_

Contributing

------------

The gearpy project welcomes your expertise and enthusiasm!

All contributions, bug reports, bug fixes, documentation improvements,

enhancements and ideas are welcome.

Writing code isn't the only way to contribute to gearpy. You can also:

- develop tutorials, presentations and other educational materials,

- maintain and improve the `documentation `_,

- help with outreach and onboard new contributors.

Have a look at the `contributing guide `_.

If you are new to contributing to open source, `this guide `_ helps explain

why, what, and how to successfully get involved.