tribology

A Python package for tribology research and education

https://github.com/moritzploss/tribology

Science Score: 33.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary

Keywords

machine-design research tribology
Last synced: 10 months ago · JSON representation

Repository

A Python package for tribology research and education

Basic Info
  • Host: GitHub
  • Owner: moritzploss
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 72 MB
Statistics
  • Stars: 17
  • Watchers: 3
  • Forks: 8
  • Open Issues: 3
  • Releases: 9
Topics
machine-design research tribology
Created over 8 years ago · Last pushed over 3 years ago
Metadata Files
Readme License

README.md

Build Status DOI

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 directory. Simple examples of how to use the package are provided in the /examples directory.

The package is provided under an MIT license. See the 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.

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. To fix this, either update to a later version of the package, or install the missing cv2 package manually:

pip install opencv-python

Owner

  • Name: Moritz Ploss
  • Login: moritzploss
  • Kind: user
  • Location: Stockholm

I like functional programming. And Go.

GitHub Events

Total
  • Watch event: 3
Last Year
  • Watch event: 3

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 528
  • Total Committers: 4
  • Avg Commits per committer: 132.0
  • Development Distribution Score (DDS): 0.542
Top Committers
Name Email Commits
moritzp m****s@g****m 242
Moritz Ploß m****s@g****m 169
moritzp m****p@k****e 116
Deployment Bot (from Travis CI) d****y@t****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 5 months
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.78
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 9
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mazikuii (1)
Pull Request Authors
  • dependabot[bot] (9)
Top Labels
Issue Labels
Pull Request Labels
dependencies (9)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 520 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 104
  • Total maintainers: 1
pypi.org: tribology

functions and constants for tribology research

  • Versions: 104
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 520 Last month
Rankings
Dependent packages count: 10.0%
Forks count: 11.9%
Average: 15.4%
Stargazers count: 16.0%
Downloads: 17.5%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 11 months ago

Dependencies

requirements.txt pypi
  • bumpversion *
  • guzzle_sphinx_theme *
  • matplotlib *
  • mock *
  • numexpr *
  • numpy <=1.16.1
  • opencv-python ==3.4.2.16
  • pillow ==5.0.0
  • pylint >=2.3.1
  • pytest *
  • scipy ==1.0.0
  • sphinx *
  • sphinx_rtd_theme *
  • sphinxcontrib-fulltoc *
  • sphinxjp.themes.dotted *
setup.py pypi
  • matplotlib *
  • numexpr *
  • numpy <=1.16.1
  • opencv-python ==3.4.2.16
  • scipy *
tribology/p3can/requirements.txt pypi
  • jinja2 >=1.1
  • matplotlib >=1.5.3
  • numexpr >=2.6.1
  • numpy >=1.11.2
  • scipy >=0.18.1