v0.5.0 (#575)

* update CHANGELOG.rst and CITATION.cff

* update CITATION.cff

* update CHANGELOG.rst

* exclude python 3.10

* format

* update release dates

* update install.rst

* finalize CHANGELOG.rst

* update cancel.yml

* add py3.10 support note

.github/workflows/cancel.yml

@@ -1,7 +1,7 @@
 name: Cancel
 on:
   workflow_run:
-    workflows: ["pytest", "pytest compat", "build", "docs"]
+    workflows: ["pytest", "build", "docs"]
     types:
       - requested
 jobs:

CHANGELOG.rst

@@ -3,9 +3,36 @@
 ###############
 
 ********************
- 0.5.0 (unreleased)
+ 0.5.0 (12.10.2021)
 ********************
 
+Release ``0.5.0`` brings a major rework of the `weldx` standard and many
+API improvements:
+
+Highlights
+==========
+
+-  `weldx` now internally uses the reworked ASDF extension API. The
+   schema and tag naming patterns have also changed to the recommended
+   ``asdf://`` format.
+
+-  New `Time` class to make handling of time related functionality
+   easier and consistent.
+
+-  many internal reworks to streamline the code.
+
+-  rework the `API documentation
+   <https://weldx.readthedocs.io/en/latest/api.html>`__ to show the most
+   important classes.
+
+Compatibility
+=============
+
+-  the ``0.5.x`` versions will retain backwards compatibility with files
+   generated with the ``0.4.x`` versions and convert them to the new
+   naming schema on save. Support for the old schemas will be dropped in
+   the ``0.6`` release.
+
 added
 =====
 
@@ -118,10 +145,11 @@ changes
    serialization still uses long notation (`[#560]
    <https://github.com/BAMWelDX/weldx/pull/560>`__))
 
--  ``welding_current`` and ``welding_voltage`` in the single-pass weld schema
-   now expect the tag ``"asdf://weldx.bam.de/weldx/tags/core/time_series-0.1.*"``
-   instead of ``"asdf://weldx.bam.de/weldx/tags/measurement/signal-0.1.*"`` `[#578]
-   <https://github.com/BAMWelDX/weldx/pull/578>`__.
+-  ``welding_current`` and ``welding_voltage`` in the single-pass weld
+   schema now expect the tag
+   ``"asdf://weldx.bam.de/weldx/tags/core/time_series-0.1.*"`` instead
+   of ``"asdf://weldx.bam.de/weldx/tags/measurement/signal-0.1.*"``
+   `[#578] <https://github.com/BAMWelDX/weldx/pull/578>`__.
 
 -  ``Geometry.__init__`` now also accepts an ``iso.IsoBaseGroove`` as ``profile``
    parameter `[#583] <https://github.com/BAMWelDX/weldx/pull/583>`__.
@@ -232,16 +260,15 @@ ASDF
 -  reworked the optional syntax for ``wx_shape`` validation `[#571]
    <https://github.com/BAMWelDX/weldx/pull/571>`__.
 
-deprecations
-============
-
 dependencies
 ============
 
 -  set ``k3d!=2.10`` because of conda dependency bugs `[#577]
    <https://github.com/BAMWelDX/weldx/pull/577>`__ `[#474]
    <https://github.com/BAMWelDX/weldx/issues/474>`__.
 
+- Python 3.10 is not supported in this version. `[#575] <https://github.com/BAMWelDX/weldx/pull/575>`__
+
 ********************
  0.4.1 (20.07.2021)
 ********************

CITATION.cff

@@ -1,8 +1,8 @@
 # YAML 1.2
 ---
 title: weldx
-#version:
-#date-released:
+version: 0.5.0
+date-released: 2021-10-12
 authors:
   - affiliation: "Bundesanstalt für Materialforschung und -prüfung (BAM)"
     email: [email protected]
@@ -24,7 +24,7 @@ authors:
     family-names: Pittner
     given-names: Andreas
     orcid: "https://orcid.org/0000-0002-5019-7775"
-message: "If you use this software, please cite it as below."
+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
@@ -48,5 +48,5 @@ abstract: |
   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"
+cff-version: 1.2.0
 ...

devtools/conda.recipe/meta.yaml

@@ -19,9 +19,9 @@ requirements:
   build:
     - pip
     - setuptools_scm
-    - python >=3.8
+    - python >=3.8,<3.10
   run:
-    - python >=3.8
+    - python >=3.8,<3.10
     # dependencies are defined in setup.py
     {% for dep in data['install_requires'] %}
     - {{ dep.lower() }}

doc/install.rst

@@ -46,11 +46,11 @@ of mixed versions of extensions in lab env and weldx env!).
 Here is a guide on howto setup different kernels for Jupyter `guide
 <https://ipython.readthedocs.io/en/7.25.0/install/kernel_install.html>`__.
 
-Create an environment named "jlab" via conda:
+Create an environment named "jlab" via conda that installs ``jupyterlab`` and the ``k3d`` extension:
 
 .. code::
 
-   conda create -n jlab jupyterlab -c conda-forge
+   conda create -n jlab jupyterlab k3d -c conda-forge
 
 Then we switch to the weldx environment created in the first step and
 make it available within Jupyter:
@@ -65,16 +65,6 @@ weldx environment within Jupyter. So when a new notebook is created, we
 can choose "Python (weldx)" to access all the software bundled with the
 weldx Python package.
 
-Build and enable Jupyter lab extensions
-=======================================
-
-We need to install several different extensions for Jupyter:
-
-.. code::
-
-   conda activate jlab
-   jupyter labextension install @jupyter-widgets/jupyterlab-manager k3d
-
 fixing DLL errors on Windows systems
 ====================================
 
@@ -125,6 +115,5 @@ using conda:
    conda create -n weldx -c conda-forge weldx
    conda activate weldx
    python -m ipykernel install --user --name weldx --display-name "Python (weldx)"
-   conda create -n jlab -c conda-forge jupyterlab
+   conda create -n jlab -c conda-forge jupyterlab k3d
    conda activate jlab
-   jupyter labextension install @jupyter-widgets/jupyterlab-manager k3d

setup.cfg

@@ -32,7 +32,7 @@ project_urls =
 
 [options]
 packages = find:
-python_requires = >=3.8
+python_requires = >=3.8,<3.10
 setup_requires =
     setuptools >=38.3.0
     setuptools_scm