From 513cb0ca57031831bca07f22e8ac6611a1b57610 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=87a=C4=9Ftay=20Fabry?= Date: Fri, 25 Aug 2023 14:23:25 +0200 Subject: [PATCH] cleanup (#888) * remove binder * update readme badges --- .binder/environment.yml | 28 ------------------- .binder/postBuild | 3 -- .github/workflows/trigger_binder_build.yml | 17 ----------- MANIFEST.in | 1 - README.md | 5 ++-- doc/src/conf.py | 15 +--------- doc/src/tutorials/01_01_introduction.ipynb | 5 +--- .../tutorials/01_02_time_dependent_data.ipynb | 4 +-- doc/src/tutorials/01_03_geometry.ipynb | 5 +--- .../tutorials/01_04_coordinate_systems.ipynb | 5 +--- ...mations_02_coordinate_system_manager.ipynb | 9 +----- 11 files changed, 8 insertions(+), 89 deletions(-) delete mode 100644 .binder/environment.yml delete mode 100644 .binder/postBuild delete mode 100644 .github/workflows/trigger_binder_build.yml diff --git a/.binder/environment.yml b/.binder/environment.yml deleted file mode 100644 index d0f8071d1..000000000 --- a/.binder/environment.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: weldx -channels: - - conda-forge - - defaults -dependencies: - - python=3.9 - - setuptools_scm - - pip - # jupyterlab setup - - jupyterlab=3 - - ipympl - # weldx - - numpy - - pandas - - xarray - - scipy - - sympy - - pint - - asdf - - bottleneck - - boltons - - networkx - - fs - - ipywidgets - - ipykernel - - k3d=2.11 - - meshio - - psutil diff --git a/.binder/postBuild b/.binder/postBuild deleted file mode 100644 index 0f4c367c3..000000000 --- a/.binder/postBuild +++ /dev/null @@ -1,3 +0,0 @@ -#!/bin/bash - -pip install -e . diff --git a/.github/workflows/trigger_binder_build.yml b/.github/workflows/trigger_binder_build.yml deleted file mode 100644 index b4074e7a9..000000000 --- a/.github/workflows/trigger_binder_build.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: trigger binder build -on: - push: - branches: - - master - -jobs: - trigger-binder-build: - runs-on: [ ubuntu-latest ] - steps: - - uses: s-weigand/trigger-mybinder-build@v1 - with: - target-repo: BAMWelDX/weldx - service-name: gh - target-state: master - use-default-build-servers: true - debug: false diff --git a/MANIFEST.in b/MANIFEST.in index 37e103c6f..7c0d8d44d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,7 +4,6 @@ recursive-include weldx/schemas *.yaml recursive-include weldx/manifests *.yaml include CITATION.cff -prune .binder prune .github prune devtools prune doc diff --git a/README.md b/README.md index ce2b8532f..49e8079e1 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,14 @@ [![CF](https://anaconda.org/conda-forge/weldx/badges/version.svg)](https://anaconda.org/conda-forge/weldx) -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/BAMWelDX/weldx/master?urlpath=lab/tree/tutorials/welding_example_01_basics.ipynb) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/5e7ede6d978249a781e5c580ed1c813f)](https://www.codacy.com/gh/BAMWelDX/weldx) [![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/BAMWelDX/weldx/?ref=repository-badge) [![Documentation](https://readthedocs.org/projects/weldx/badge/?version=latest)](https://weldx.readthedocs.io/en/latest/?badge=latest) [![License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause) [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.5565185.svg)](https://doi.org/10.5281/zenodo.5565185) [![codecov](https://codecov.io/gh/BAMWelDX/weldx/branch/master/graph/badge.svg)](https://codecov.io/gh/BAMWelDX/weldx) -[![conda build](https://github.com/BAMWelDX/weldx/workflows/conda%20build/badge.svg?branch=master)](https://github.com/BAMWelDX/weldx/actions?query=workflow%3A%22conda+build%22+branch%3Amaster) -[![documentation-gh](https://github.com/BAMWelDX/weldx/workflows/documentation/badge.svg?branch=master)](https://github.com/BAMWelDX/weldx/actions?query=workflow%3Adocumentation+branch%3Amaster) +[![package builds](https://github.com/BAMWelDX/weldx/workflows/package%20builds/badge.svg?branch=master)](https://github.com/BAMWelDX/weldx/actions?query=workflow%3A%22package%20builds%22+branch%3Amaster) +[![documentation-gh](https://github.com/BAMWelDX/weldx/workflows/documentation%20builds/badge.svg?branch=master)](https://github.com/BAMWelDX/weldx/actions?query=workflow%3Adocumentation%20builds+branch%3Amaster) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/BAMWelDX/weldx/master.svg)](https://results.pre-commit.ci/latest/github/BAMWelDX/weldx/master) [![pytest](https://github.com/BAMWelDX/weldx/workflows/pytest/badge.svg?branch=master)](https://github.com/BAMWelDX/weldx/actions?query=workflow%3Apytest+branch%3Amaster) [![static analysis](https://github.com/BAMWelDX/weldx/workflows/static%20analysis/badge.svg?branch=master)](https://github.com/BAMWelDX/weldx/actions?query=workflow%3A%22static+analysis%22+branch%3Amaster) diff --git a/doc/src/conf.py b/doc/src/conf.py index 52961a78c..bc513693a 100644 --- a/doc/src/conf.py +++ b/doc/src/conf.py @@ -173,20 +173,7 @@ def _prevent_sphinx_circular_imports_bug(): ] # This is processed by Jinja2 and inserted before each notebook -nbsphinx_prolog = r""" -{% set docname = env.doc2path(env.docname, base=None).replace("\\","/") %} - -.. only:: html - - .. role:: raw-html(raw) - :format: html - - .. nbinfo:: - - Run the interactive online version of this notebook (takes 1-2 minutes to load): - :raw-html:`Binder badge` - -""" +# nbsphinx_prolog = "" nbsphinx_epilog = """ ---- diff --git a/doc/src/tutorials/01_01_introduction.ipynb b/doc/src/tutorials/01_01_introduction.ipynb index 04da4e996..af5392699 100644 --- a/doc/src/tutorials/01_01_introduction.ipynb +++ b/doc/src/tutorials/01_01_introduction.ipynb @@ -29,7 +29,6 @@ "\n", "However, we strongly recommend to run and read the tutorials in a running jupyter-lab session.\n", "Some features like interactive plots can only be displayed correctly by a jupyter server.\n", - "In case you don't have the `weldx` package or jupyter-lab installed yet but want to test the tutorial code, you can click on the binder link button that can be found at the top of each tutorial in the online version of the documentation.\n", "This will start a virtual machine with everything set up correctly that you can access through your browser.\n", "\n", "## Opening and navigating through WelDX Files\n", @@ -102,9 +101,7 @@ "If you are running a jupyter notebook, you can use the `header` method of `WeldxFile` to get a nicely rendered overview of the file content. \n", "The output might vary if you are running the classic notebook environment or a Jupyter-Lab environment.\n", "In the latter case, you will get an interactive, clickable tree view to navigate through the file content.\n", - "Uncomment the code in the next cell to try it out:\n", - "\n", - "> HINT: Remember that you can start a jupyter-lab version of this notebook in our online documentation by clicking at the binder link at the start of this tutorial" + "Uncomment the code in the next cell to try it out:\n" ] }, { diff --git a/doc/src/tutorials/01_02_time_dependent_data.ipynb b/doc/src/tutorials/01_02_time_dependent_data.ipynb index 24bda77d8..07fdc132b 100644 --- a/doc/src/tutorials/01_02_time_dependent_data.ipynb +++ b/doc/src/tutorials/01_02_time_dependent_data.ipynb @@ -154,9 +154,7 @@ "metadata": {}, "source": [ "Now let's plot the welding voltage. \n", - "Try to interact with the plot if you are running this tutorial as a jupyter notebook.\n", - "\n", - "> HINT: Remember that you can run the code of this tutorial by clicking on the binder link at the beginning" + "Try to interact with the plot if you are running this tutorial as a jupyter notebook.\n" ] }, { diff --git a/doc/src/tutorials/01_03_geometry.ipynb b/doc/src/tutorials/01_03_geometry.ipynb index 3bd8af26e..1bf24c243 100644 --- a/doc/src/tutorials/01_03_geometry.ipynb +++ b/doc/src/tutorials/01_03_geometry.ipynb @@ -298,10 +298,7 @@ "By default, `plot` relies on matplotlib as rendering backend.\n", "We have already mentioned before that this is not ideal for 3d renderings.\n", "Therefore, the `weldx` package offers an alternative for jupyter notebook users.\n", - "You can select the `k3d` package as rendering backend as follows:\n", - "\n", - "> HINT: In the plain html documentation, you can't interact with the plots. \n", - " Click on the binder link button at the beginning of the tutorial to start a jupyter-lab session of this tutorial." + "You can select the `k3d` package as rendering backend as follows:\n" ] }, { diff --git a/doc/src/tutorials/01_04_coordinate_systems.ipynb b/doc/src/tutorials/01_04_coordinate_systems.ipynb index d502de619..8b389f180 100644 --- a/doc/src/tutorials/01_04_coordinate_systems.ipynb +++ b/doc/src/tutorials/01_04_coordinate_systems.ipynb @@ -314,10 +314,7 @@ "So we can safely use the original CSM that we stored in the variable `csm`.\n", "\n", "The CSM's `plot`method offers a high level of interactivity when using `k3d` as renderer.\n", - "This reduces the amount of parameters you need to remember or look up if you want to modify the graphical output to your liking.\n", - "\n", - "> Note that the the control surfaces below the plot are not functional in the online documentation.\n", - "You can start a jupyter-lab server inside your browser by clicking at the binder link at the start of this tutorial." + "This reduces the amount of parameters you need to remember or look up if you want to modify the graphical output to your liking.\n" ] }, { diff --git a/doc/src/tutorials/transformations_02_coordinate_system_manager.ipynb b/doc/src/tutorials/transformations_02_coordinate_system_manager.ipynb index f90d3d617..22f07a231 100644 --- a/doc/src/tutorials/transformations_02_coordinate_system_manager.ipynb +++ b/doc/src/tutorials/transformations_02_coordinate_system_manager.ipynb @@ -14,11 +14,6 @@ "\n", "This tutorial builds upon the [tutorial about coordinate systems](transformations_01_coordinate_systems.ipynb), but its content can still be understood without reading the other one first.\n", "\n", - "> HINT: \n", - "> This tutorial contains interactive plots. \n", - "> In the readthedocs/html version of this tutorial, the function set is very limited.\n", - "> By clicking on the binder-link at the top of the document, you can start a fully interactive jupyter-lab online session of this tutorial.\n", - "\n", "## Imports" ] }, @@ -336,9 +331,7 @@ "If you are running a jupyter notebook, you can use k3d as rendering backend.\n", "It has a much more powerful rendering engine suited for 3d plots that can handle a vast amount of data and provides an interactive rendering window.\n", "Furthermore, the `plot` function of the CSM creates some additional control surfaces if k3d is used.\n", - "This gives you the opportunity to modify the plot directly using buttons, checkboxes, sliders, etc. instead of recreating it with a different set of function parameters: \n", - "\n", - "> HINT: Note that some of the interactive functionality can't be used in the readthedocs documentation. Click on the binder link at the top of the document to start a jupyter-lab session that runs this tutorial online." + "This gives you the opportunity to modify the plot directly using buttons, checkboxes, sliders, etc. instead of recreating it with a different set of function parameters: \n" ] }, {