Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
phlptp committed Dec 26, 2024
1 parent a1183b8 commit 3c52ee3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ All notable changes to this project after the 0.2.0 release will be documented i
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.11.0][] -2024-12-25
## [0.11.0][] -2024-12-26

Python package release, and other updates and fixes
Python package release, documentation update, continued addition of new units and other updates and fixes

### Changed

Expand Down
11 changes: 9 additions & 2 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
- [Owen Arnold](https://github.com/OwenArnold) - Documentation
- [Peter Steneteg](https://github.com/petersteneteg)
- [Jan-Lukas Wynen](https://github.com/jl-wynen) - Support for multi-digit power strings

- [Jiahao Wen](https://github.com/wkindling) - Fixes for cmake standard condition

## Used Libraries or Code

### [GridDyn](https://github.com/LLNL/GridDyn)
Expand All @@ -34,15 +35,21 @@ Boost is used for the webserver code. There is no dependency elsewhere in the li

The converter app uses CLI11 as part of the command line processing for the converter app and the single header file is included in the repository. It is not used in the units library itself. A number of the CI scripts and structures and github actions were borrowed from the CLI11 repository. CLI11 is released with a BSD-3-clause license.

### [nanobind](https://github.com/wjakob/nanobind)

Nanobind is a small binding library that exposes C++ types in Python and vice versa. It is used for creating the python bindings for the library. Nanobind is released with a BSD-3-Clause license.

## References for Unit definitions

- [UDUNITS-2](https://github.com/Unidata/UDUNITS-2) The UDUNITS package supports units of physical quantities. Its C library provides for arithmetic manipulation of units and for conversion of numeric values between compatible units. The package contains an extensive unit database, which is in XML format and user-extendable. The package also contains a command-line utility for investigating units and converting values. Some of the unit definition files are used to test the library to ensure compatibility with the definitions in this library. Some of the definitions files are included. UDUNITS-2 is licensed with a [BSD-3-clause](https://github.com/Unidata/UDUNITS-2/blob/master/COPYRIGHT) with an additional clause revoking the license on allegations of patent infringement. No code from UDUNITS-2 is used, only the unit definitions files.
- [ucum-lhc](https://github.com/lhncbc/ucum-lhc) This is the LHC implementation of validation and conversion services based on the [Unified Code for Units of Measure](http://unitsofmeasure.org/) (UCUM) code system created by the Regenstrief Institute, Inc. The repository is licensed under a [BSD](https://github.com/lhncbc/ucum-lhc/blob/master/LICENSE.md) license. No code is used in units, but the unit definition files are used for testing purposes and some of the JSON files are included in the repository.
- [google unit conversions](https://support.google.com/websearch/answer/3284611?hl=en#unitconverter) Google unit conversion support was examined to provide additional unit strings and some conversion values.

- [convert me](https://www.convert-me.com/en/) unit converter web site used as test and check for various conversions

### cmake scripts

Several CMake scripts came from other sources and were either used or modified for use in HELICS.

- Lars Bilke [CodeCoverage.cmake](https://github.com/bilke/cmake-modules/blob/master/CodeCoverage.cmake)
- [HELICS](https://github.com/GMLC-TDC/HELICS) Some of the code CMake and build scripts and a few of the docker images used for testing are maintained through the HELICS library. HELICS also uses the units library for unit translations.
- [Nanobind example](https://github.com/wjakob/nanobind_example) much of the scripts for the the Python binding and CI jobs was copied and modified from the nanobind example repo.
4 changes: 2 additions & 2 deletions docs/user-guide/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Python
==================
The Python wrapper for the units library is a simplified version of the library. It is focused on the string operations of the library and conversions between units and measurements.

The units library is available through a pypi package
The units library is available through a pypi_ package

.. code-block:: sh
Expand Down Expand Up @@ -41,7 +41,7 @@ This will print a result `20 m/s = 44.73872584108805 mph`
This will produce `20 m/s = 44.7387258411 mph`

See the pypi_ for a complete description of all methods and functions
See the pypi_ landing page for a complete description of all methods and functions.

.. _pypi: https://pypi.org/project/units-llnl/

Expand Down

0 comments on commit 3c52ee3

Please sign in to comment.