Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs seo #312

Merged
merged 15 commits into from
Mar 30, 2021
7 changes: 7 additions & 0 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ jobs:
- name: pip installs
run: pip install -e .[test]

- name: setup matplotlib
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the default matplotlib backend used on Windows is somehow broken (TK library cannot be found for whatever reason). To work around this I forcefully use the Agg backend for this OS.

if: startsWith(runner.os, 'Windows')
run: |
if not exist %userprofile%\.matplotlib\ ( mkdir %userprofile%\.matplotlib\ )
echo "backend: Agg" > %userprofile%\.matplotlib\matplotlibrc
shell: cmd

- name: run pytest
run: |
pytest -n 2 --runslow tests/
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
import weldx
except Exception as ex:
raise

import weldx.visualization # load visualization
from weldx.asdf.constants import WELDX_TAG_BASE

Expand Down
10 changes: 9 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
============================================================
WelDX - data and quality standards for welding research data
============================================================

.. meta::
:description lang=en: Scientific data format and Python API for welding research data. Setup your experiment and capture data in a single file.
:keywords: welding, weld, data format, archive, scientific data, experiment, visualization, GMAW, quality standard, objectivity, comparability, reproducibility, measurement chain

.. meta::
:google-site-verification: YvWuHWCE9tERkKT7KQejAwHM2cJVSfDewd5IzGZxDsU

Introduction
############
Scientific welding data covers a wide range of physical domains and timescales and are measured using various different sensors.
Expand All @@ -12,6 +20,7 @@ The proposed file format will be developed with regards to current needs of the
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).
Visit the projects site at `BAM <https://www.bam.de/Content/EN/Projects/WelDX/weldx.html>`_.

Python API
##########
Expand Down Expand Up @@ -48,7 +57,6 @@ Funding
#######
This research is funded by the Federal Ministry of Education and Research of Germany under project number 16QK12.


.. toctree::
:hidden:
:maxdepth: 1
Expand Down