https://github.com/moritzploss/tribology
A Python package for tribology research and education
https://github.com/moritzploss/tribology
machine-design research tribology
Last synced: about 1 year ago
JSON representation
A Python package for tribology research and education
- Host: GitHub
- URL: https://github.com/moritzploss/tribology
- Owner: moritzploss
- License: mit
- Created: 2017-11-15T11:36:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-22T02:21:27.000Z (over 3 years ago)
- Last Synced: 2025-03-17T19:52:27.276Z (over 1 year ago)
- Topics: machine-design, research, tribology
- Language: Python
- Homepage:
- Size: 72 MB
- Stars: 13
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/moritzploss/tribology)
[](https://zenodo.org/badge/latestdoi/110825481)
# tribology
This Python 3 package is a collection of functions for
tribology research and education, including contact mechanics,
lubrication science, data handling and data processing. It provides
implementations of analytical and numerical calculation routines together with
frequently used constants.
The **tribology package** is hosted on GitHub:
https://github.com/moritzploss/tribology
You can **install** the package from the
**PyPI**
index using pip:
pip install tribology
After installation, it is recommended to **import** the package and all
its modules as follows:
```python
import tribology as tr
```
The package
**
documenation** is provided through GitHub Pages; the Sphinx source files
can be found in the [`/docs`](./docs) directory. Simple examples of how to use
the package are provided in the [`/examples`](./examples) directory.
The package is provided under an MIT license. See the
[`LICENSE.txt`](LICENSE.txt) file for more information.
# use in scientific publications
You can refer to the tribology package in **scientific publications** by
using its DOI. The following DOI will resolve all releases of the
package and automatically point to the latest release. A more detailed
overview of the DOI release history can be found through
**Zenodo**:
DOI: 10.5281/zenodo.1117727
The suggested citation format is:
[List of contributors] et al., Tribology -- A Python Package for Tribology
Research and Education, version v[x.x.x] ([date]). doi: [DOI]
# version history
Please refer to the release history for a detailed overview.
# known issues
### numpy
The following releases of NumPy may cause file access errors when using data
import and processing routines of the tribology package. It is
recommended to use the NumPy release(s) specified in [`setup.py`](setup.py).
1.16.2
1.16.3
### missing install requires
Some older versions of the tribology package (0.4 <= version < 0.5) may raise the
following error when imported:
ModuleNotFoundError: No module named 'cv2'
This is caused by a missing `install_requires` argument in
[`setup.py`](./setup.py). To fix this, either update to a later version of the
package, or install the missing `cv2` package manually:
pip install opencv-python