Metadata-Version: 2.1
Name: weldx
Version: 0.5.0
Summary: Python API for the WelDX file format and standard
Home-page: https://www.bam.de/weldx
Author: "Cagtay Fabry <cagtay.fabry@bam.de>, Volker Hirthammer <volker.hirthammer@bam.de>, Martin K. Scherer <martin.scherer@bam.de>"
Author-email: "cagtay.fabry@bam.de"
License: BSD License
Project-URL: Documentation, https://weldx.readthedocs.io
Project-URL: Source Code, https://github.com/BAMweldx/weldx
Project-URL: Bug Tracker, https://github.com/BAMweldx/weldx/issues
Project-URL: Changelog, https://github.com/BAMweldx/weldx/blob/master/CHANGELOG.rst
Keywords: welding,weldx,bam
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <3.10,>=3.8
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.18)
Requires-Dist: pandas (>=1.0)
Requires-Dist: xarray (>=0.15)
Requires-Dist: scipy (!=1.6.0,!=1.6.1,>=1.4)
Requires-Dist: sympy (>=1.6)
Requires-Dist: pint (>=0.11)
Requires-Dist: asdf (>=2.8)
Requires-Dist: bottleneck (>=1.3)
Requires-Dist: boltons
Requires-Dist: networkx (>=2)
Requires-Dist: matplotlib (>=3)
Requires-Dist: fs
Requires-Dist: ipywidgets
Requires-Dist: ipykernel (<6.4)
Requires-Dist: k3d (!=2.10)
Requires-Dist: meshio
Requires-Dist: psutil
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-xdist ; extra == 'test'
Requires-Dist: nbval ; extra == 'test'

##############################################################
 WelDX - data and quality standards for welding research data
##############################################################

|Documentation| |Binder| |Anaconda-Server Badge| |License|

**********
 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
<https://www.bam.de/Navigation/EN/About-us/Organisation/Organisation-Chart/President/Department-9/Division-93/division93.html>`__
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
   <https://www.iso.org/standard/62520.html>`__ 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
<https://en.wikipedia.org/wiki/Advanced_Scientific_Data_Format>`__
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 <https://weldx.readthedocs.io/en/stable/api.html>`__. Further
we provide rich `Jupyter notebook tutorials
<https://weldx.readthedocs.io/en/stable/tutorials.html>`__ 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
<https://pint.readthedocs.io/en/stable/>`__, which flawlessly handles
the creation and conversion of units and dimensions.

**************
 Publications
**************

-  Recommendations for an Open Science approach to welding process
   research data. Fabry, C., Pittner, A., Hirthammer, V. et al. *Weld
   World* (2021). https://doi.org/10.1007/s40194-021-01151-x

**************
 Installation
**************

The WelDX package can be installed using conda or mamba package manager
from the :code:``conda-forge`` channel. These managers originate from
the freely available `Anaconda Python stack
<https://docs.conda.io/en/latest/miniconda.html>`__. 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
<https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation>`__.
After this step you have access to the conda command and can proceed to
installing the WelDX package.

.. code:: console

   conda install weldx -c conda-forge

The package is also available on pypi.

.. code:: console

   pip install weldx

***************
 Documentation
***************

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

-  `latest <https://weldx.readthedocs.io/en/latest/>`__
-  `stable <https://weldx.readthedocs.io/en/stable/>`__

*********
 Funding
*********

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

*******************
 Repository status
*******************

Continuous Integration
======================

|pytest| |conda build|

Code Status
===========

|static analysis| |pre-commit.ci status| |Codacy Badge| |codecov|
|DeepSource|

Documentation build
===================

|Documentation| |documentation-gh|

.. |Documentation| image:: https://readthedocs.org/projects/weldx/badge/?version=latest
   :target: https://weldx.readthedocs.io/en/latest/?badge=latest

.. |Binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/BAMWelDX/weldx/master?urlpath=lab/tree/tutorials/welding_example_01_basics.ipynb

.. |Anaconda-Server Badge| image:: https://anaconda.org/conda-forge/weldx/badges/version.svg
   :target: https://anaconda.org/conda-forge/weldx

.. |License| image:: https://img.shields.io/badge/License-BSD%203--Clause-orange.svg
   :target: https://opensource.org/licenses/BSD-3-Clause

.. |pytest| image:: https://github.com/BAMWelDX/weldx/workflows/pytest/badge.svg?branch=master
   :target: https://github.com/BAMWelDX/weldx/actions?query=workflow%3Apytest+branch%3Amaster

.. |conda build| image:: https://github.com/BAMWelDX/weldx/workflows/conda%20build/badge.svg?branch=master
   :target: https://github.com/BAMWelDX/weldx/actions?query=workflow%3A%22conda+build%22+branch%3Amaster

.. |static analysis| image:: https://github.com/BAMWelDX/weldx/workflows/static%20analysis/badge.svg?branch=master
   :target: https://github.com/BAMWelDX/weldx/actions?query=workflow%3A%22static+analysis%22+branch%3Amaster

.. |pre-commit.ci status| image:: https://results.pre-commit.ci/badge/github/BAMWelDX/weldx/master.svg
   :target: https://results.pre-commit.ci/latest/github/BAMWelDX/weldx/master

.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/5e7ede6d978249a781e5c580ed1c813f
   :target: https://www.codacy.com/gh/BAMWelDX/weldx?utm_source=github.com&utm_medium=referral&utm_content=BAMWelDX/weldx&utm_campaign=Badge_Grade

.. |codecov| image:: https://codecov.io/gh/BAMWelDX/weldx/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/BAMWelDX/weldx

.. |DeepSource| image:: https://static.deepsource.io/deepsource-badge-light-mini.svg
   :target: https://deepsource.io/gh/BAMWelDX/weldx/?ref=repository-badge

.. |documentation-gh| image:: https://github.com/BAMWelDX/weldx/workflows/documentation/badge.svg?branch=master
   :target: https://github.com/BAMWelDX/weldx/actions?query=workflow%3Adocumentation+branch%3Amaster


