Base utilities for engineering packages
pip install dx-utilities==1.0.2
dx-utilities
packageA collection of base utilities for engineering software packages.
Create virtual environment:
$ make install
Activate virtual environment and run tests:
$ source venv/bin/activate
$ nose2
$ pip install git://git@gitlab.com/d-e/dx-utilities.git#egg=dx_utilities
$ pip install dx-utilities
Geometry module on top of shapely
_.
Representations of physical fields.
Linear algebra and numerical integration
numpy
and mathutils.Vector
.Decorators.
Exception classes with error-code.
Data-structures.
Book-keeping of physical constants and manipulation of units.
Testing and printing utilities
>>> from dx_utilities.geometry import PlanarShape
>>> rectangle = PlanarShape.new(shape='rectangle', bx=1.0, by=2.0)
>>> rectangle.area
2.0
Source code lives in https://gitlab.com/d-e/dx-utilities.
We abide by the provisions of Contributor Coventant Code of Conduct.
Follow this simplified gitflow model.
We follow semantic versioning.
Documentation is generated through continuous-integration (CI). For review purposes it can be generated locally with:
$ make MODPATH=../dx_utilities -C docs apidoc html
For more details on the process run
$ make docs-help
The package includes coded exceptions. The list of error codes, along
with associated metadata is generated in ERROR_CODES.md
.
Upon refactoring or additions of coded exceptions this list must be regenerated through
$ make parse-error-codes
See the documentation pages.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.