Science Score: 67.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
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: jdejulio
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: master
  • Size: 40.3 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 0
Created about 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Changelog License Citation

README.md

WelDX - data and quality standards for welding research data

CF Codacy Badge DeepSource Documentation License Zenodo codecov package builds documentation-gh pre-commit.ci status pytest static analysis

Overview

Scientific welding data covers a wide range of physical domains and timescales and are measured using various different sensors. Complex and highly specialized experimental setups at different welding institutes complicate the exchange of welding research data further.

The WelDX research project aims to foster the exchange of scientific data inside the welding community by developing and establishing a new open source file format suitable for the documentation of experimental welding data and upholding associated quality standards. In addition to fostering scientific collaboration inside the national and international welding community an associated advisory committee will be established to oversee the future development of the file format. The proposed file format will be developed with regard to current needs of the community regarding interoperability, data quality and performance and will be published under an appropriate open source license. By using the file format objectivity, comparability and reproducibility across different experimental setups can be improved.

The project is under active development by the Welding Technology division at Bundesanstalt für Materialforschung und -prüfung (BAM).

Features

WelDX provides several Python API to perform standard tasks like experiment design, data analysis, and experimental data archiving.

Planning

  • Define measurement chains with all involved devices, error sources, and metadata annotations.
  • Handle complex coordinate transformations needed to describe the movement of welding robots, workpieces, and sensors.
  • Planing of welding experiments.
  • convenient creation of ISO 9692-1 welding groove types.

Data analysis

  • Plotting routines to inspect measurement chains, workpieces (planned and welded).
  • Analysis functions for standard measurements like track energy, welding speed to fill an ISO groove, and more to come.

Data archiving

The ultimate goal of this project is to store all information about the experiment in a single file. We choose the popular ASDF format for this task. This enables us to store arbitrary binary data, while maintaining a human readable text based header. All information is stored in a tree like structure, which makes it convenient to structure the data in arbitrary complex ways.

The ASDF format and the provided extensions for WelDX types like

  • workpiece information (used alloys, geometries)
  • welding process parameters (GMAW parameters)
  • measurement data
  • coordinate systems (robot movement, sensors)

enables us to store the whole experimental pipeline performed in a modern laboratory.

Design goals

We seek to provide a user-friendly, well documented programming interface. All functions and classes in WelDX have attached documentation about the involved parameters (types and explanation), see API docs. Further we provide rich Jupyter notebook tutorials about the handling of the basic workflows.

All involved physical quantities used in weldx (lengths, angles, voltages, currents, etc.) should be attached with a unit to ensure automatic conversion and correct mathematical handling. Units are being used in all standard features of WelDX and are also archived in the ASDF files. This is implemented by the popular Python library Pint, which flawlessly handles the creation and conversion of units and dimensions.

Publications

Installation

The WelDX package can be installed using conda or mamba package manager from the Conda-Forge channel. These managers originate from the freely available Anaconda Python stack. If you do not have Anaconda or Miniconda installed yet, we ask you to install Miniconda-3. Documentation for the installation procedure can be found here. After this step you have access to the conda command and can proceed to installing the WelDX package.

console conda install weldx weldx_widgets -c conda-forge

The package is also available on pypi.

console pip install weldx weldx-widgets

Documentation

The full documentation is published on readthedocs.org. Click on one of the following links to get to the desired version:

Funding

This research is funded by the Federal Ministry of Education and Research of Germany under project number 16QK12.

Owner

  • Login: jdejulio
  • Kind: user

Citation (CITATION.cff)

# YAML 1.2
---
title: weldx
version: 0.6.7
date-released: 2023-08-24
authors:
  - affiliation: "Bundesanstalt für Materialforschung und -prüfung (BAM)"
    email: cagtay.fabry@bam.de
    family-names: Fabry
    given-names: Cagtay
    orcid: "https://orcid.org/0000-0002-0788-8079"
  - affiliation: "Bundesanstalt für Materialforschung und -prüfung (BAM)"
    email: volker.hirthammer@bam.de
    family-names: Hirthammer
    given-names: Volker
    orcid: " https://orcid.org/0000-0002-0160-969X"
  - affiliation: "Bundesanstalt für Materialforschung und -prüfung (BAM)"
    email: martin.scherer@bam.de
    family-names: Scherer
    given-names: Martin K.
    orcid: "https://orcid.org/0000-0002-7983-4387"
  - affiliation: "Bundesanstalt für Materialforschung und -prüfung (BAM)"
    email: andreas.pittner@bam.de
    family-names: Pittner
    given-names: Andreas
    orcid: "https://orcid.org/0000-0002-5019-7775"
message: "If you use this software in your work, please cite it using the following metadata."
repository-code: "https://github.com/BAMWelDX/weldx"
keywords:
  - weldx
  - welding
  - "research data"
abstract: |
  "Scientific welding data covers a wide range of physical domains and
  timescales and are measured using various different sensors. Complex and
  highly specialized experimental setups at different welding institutes
  complicate the exchange of welding research data further.

  The WelDX research project aims to foster the exchange of scientific
  data inside the welding community by developing and establishing a new
  open source file format suitable for the documentation of experimental
  welding data and upholding associated quality standards. In addition to
  fostering scientific collaboration inside the national and international
  welding community an associated advisory committee will be established
  to oversee the future development of the file format. The proposed file
  format will be developed with regard to current needs of the community
  regarding interoperability, data quality and performance and will be
  published under an appropriate open source license. By using the file
  format objectivity, comparability and reproducibility across different
  experimental setups can be improved."
cff-version: 1.2.0
...

GitHub Events

Total
Last Year

Dependencies

.github/workflows/build_pkg.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
  • mamba-org/setup-micromamba v1.8.1 composite
.github/workflows/changelog.yml actions
  • actions/checkout v4 composite
.github/workflows/citation.yml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • mamba-org/setup-micromamba v1.8.1 composite
.github/workflows/pytest.yml actions
  • CagtayFabry/pydeps2env main composite
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v4.4.0 composite
  • mamba-org/setup-micromamba v1.8.1 composite
.github/workflows/pytest_asdf.yml actions
  • CagtayFabry/pydeps2env main composite
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • jannekem/run-python-script-action v1 composite
  • mamba-org/setup-micromamba v1.8.1 composite
.github/workflows/static_analysis.yml actions
  • CagtayFabry/pydeps2env main composite
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • mamba-org/setup-micromamba v1.8.1 composite
  • pr-annotators/mypy-pr-annotator v1.0.0 composite
  • pre-commit/action v3.0.1 composite
.github/workflows/unit_test_results.yml actions
  • EnricoMi/publish-unit-test-result-action v2 composite
devtools/environment.yml pypi
doc/json_mime_render_plugin/pyproject.toml pypi
pyproject.toml pypi
  • IPython *
  • asdf >=2.15.1
  • bidict *
  • boltons *
  • bottleneck >=1.3.3
  • fs *
  • meshio *
  • networkx >=2.8.2
  • numpy >=1.20
  • pandas >=1.5
  • pint >=0.18
  • pint-xarray >=0.3
  • psutil *
  • scipy >=1.6.2
  • sympy >=1.6
  • xarray >=2022.9