Data

Tools

Indexes

Applications

Experiments

Open Source Science

unitsafe

A friendly way to handle engineering units in Python.

https://github.com/jsbayley/unitsafe

Science Score: 44.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary

Keywords

engineering maths units-of-measure
Last synced: 6 months ago · JSON representation ·

Repository

A friendly way to handle engineering units in Python.

Basic Info
  • Host: GitHub
  • Owner: jsbayley
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 42 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Topics
engineering maths units-of-measure
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Funding License Code of conduct Citation

README.md

Unitsafe

A friendly way to handle engineering units in Python.

[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/jamesbayley/unitsafe) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](https://github.com/jamesbayley/unitsafe/blob/main/.github/CODE_OF_CONDUCT.md) [![Python](https://img.shields.io/badge/Python-3.8_|_3.9_|_3.10_|_3.11_|_3.12-3776ab?logo=python&&logoColor=white)](https://www.python.org) [![CI](https://github.com/jamesbayley/unitsafe/actions/workflows/ci.yml/badge.svg)](https://github.com/jamesbayley/unitsafe/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-00add8)](https://choosealicense.com/licenses/mit/)

Table of Contents

Project Goals

  1. Offer an intuitive experience for engineering unit conversion to reduce software errors.
  2. Enhance the domain model and clarity of software by explicitly encoding design intent.
  3. Provide richer intellisense for numeric quantities in code editors.

Documentation

Please visit the Software Design Document to learn more.

Open Source

Unitsafe is proudly open-source under MIT.

Contributing

For those interested in helping to build Unitsafe, please ⭐️ and 'watch' this repository so that you can track its progress in real-time.

I am always on the lookout for new contributors to help:

  • Propose design improvements,
  • Develop and maintain the project,
  • Enhance the testing and performance suite.

Errata

Unitsafe aspires to achieve the highest standards of professional rigour. Engineering software is often safety critical. I strive to ensure stability, robustness and correctness throughout the source code, test suite and companion documentation. Nevertheless, I am human and mistakes are possible.

I recommend that all users carefully review the code, tests and documentation. Please submit error reports and suggestions for improvement via GitHub Issues. For anyone who would like to attempt a fix or improvement, I would encourage you to review the Contributing guidance and submit a Pull Request.

Owner

  • Name: James S. Bayley
  • Login: jsbayley
  • Kind: user
  • Location: Birmingham, UK

I write software for Structural Engineers.

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Unitsafe
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: James
    family-names: Bayley
repository-code: 'https://github.com/jamesbayley/unitsafe'
abstract: >-
  A friendly way to handle engineering units in Python.
keywords:
  - Mathematics
  - Engineering
  - Units
license: MIT

GitHub Events

Total
Last Year

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite
.devcontainer/Dockerfile docker
  • mcr.microsoft.com/devcontainers/base ubuntu-22.04 build
pyproject.toml pypi
  • pytest ^8.2.0 develop
  • ruff ^0.4.2 develop
  • python >=3.10
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v5 composite