From 75c7f9ac92f1d3bfcb5c61165b12b960f33e74ec Mon Sep 17 00:00:00 2001 From: BruegelN Date: Tue, 14 Feb 2023 21:12:43 +0100 Subject: [PATCH 1/2] Update mkdocs.yml Make it compliant with recent mkdocs(>=1.4.2) and mkdocs-material(>= 9.0.0) versions. cf https://squidfunk.github.io/mkdocs-material/upgrade/ --- mkdocs.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 264740d7..348c91c9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,14 +10,13 @@ remote_branch: 'gh-pages' theme: name: material favicon: 'favicon.ico' - logo: - icon: ' ' + icon: '' palette: primary: 'light blue' accent: 'blue' extra: social: - - type: 'github' + - icon: fontawesome/brands/github-alt link: 'https://github.com/libigl/libigl-python-bindings' markdown_extensions: - codehilite From 7534b9fc786029c6c008af5fb7fca14846bdc356 Mon Sep 17 00:00:00 2001 From: BruegelN Date: Sun, 26 Feb 2023 09:30:55 +0100 Subject: [PATCH 2/2] replace conda badges with PyPI * update references to conda installation with pip * make tutorial/tutorials.ipynb a valid notebook file * fix import in tutorial/tut-chapter7.ipynb --- tutorial/contributing.md | 4 ++-- tutorial/index.md | 9 ++++----- tutorial/tut-chapter0.ipynb | 14 ++++++-------- tutorial/tut-chapter1.ipynb | 6 ++---- tutorial/tut-chapter2.ipynb | 6 ++---- tutorial/tut-chapter3.ipynb | 6 ++---- tutorial/tut-chapter4.ipynb | 6 ++---- tutorial/tut-chapter5.ipynb | 6 ++---- tutorial/tut-chapter6.ipynb | 6 ++---- tutorial/tut-chapter7.ipynb | 8 +++----- tutorial/tutorials.ipynb | 20 ++++++++------------ 11 files changed, 35 insertions(+), 56 deletions(-) diff --git a/tutorial/contributing.md b/tutorial/contributing.md index 0b288a40..efad2673 100644 --- a/tutorial/contributing.md +++ b/tutorial/contributing.md @@ -7,8 +7,8 @@ If you want to contribute and expose additional features, thank you! For any new binding please create a new pull request on git, if everything looks good we will merge it. -**Note 1**, see your new feature in the conda version it might require some time, since we are planning to accumulate several fixes and -features before publishing a new version on conda. +**Note 1**, see your new feature in the conda/pip version it might require some time, since we are planning to accumulate several fixes and +features before publishing a new version on conda/PPI. **Note 2** we are not planning to bind any function not under MIT/LGLP licence since it would make the whole package not LGPL. If you plan to bind something dependent on CGAL/Triangle/TetGen, don't do it. diff --git a/tutorial/index.md b/tutorial/index.md index a3a6f333..4abe8aa2 100644 --- a/tutorial/index.md +++ b/tutorial/index.md @@ -1,9 +1,8 @@ igl python bindings =================== -[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge) -[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl) -[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl) +[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/) +[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain) !!! warning @@ -11,9 +10,9 @@ igl python bindings [libigl](https://libigl.github.io) is a simple C++ geometry processing library. We have a wide functionality including construction of sparse discrete differential geometry operators and finite-elements matrices such as the cotangent Laplacian and diagonalized mass matrix, simple facet, and edge-based topology data structures. -All these functionalities are now available through python and can be easily installed with conda: +All these functionalities are now available through python and can be easily installed with pip: ```bash -conda install -c conda-forge igl +python -m pip install libigl ``` We provide a complete jupyter version of the tutorials and the full [documentation](igl_docs.md). diff --git a/tutorial/tut-chapter0.ipynb b/tutorial/tut-chapter0.ipynb index e20fa7fd..fe064ab7 100644 --- a/tutorial/tut-chapter0.ipynb +++ b/tutorial/tut-chapter0.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 0\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)\n", + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)\n", "\n", "![](images/libigl-logo.jpg)" ] @@ -35,15 +33,15 @@ "\n", "\n", "## Downloading Libigl\n", - "Libigl can be downloaded from [Conda forge](https://anaconda.org/conda-forge/igl):\n", + "Libigl can be downloaded from [PyPI](https://pypi.org/project/libigl/):\n", "```\n", - "conda install -c conda-forge igl \n", + "python -m pip install libigl \n", "```\n", "\n", "\n", - "All of libigl functionality depends only on `numpy` and `scipy`. For the visualization in this tutorial we use [meshplot](https://anaconda.org/conda-forge/meshplot) which can be easily installed from Conda:\n", + "All of libigl functionality depends only on `numpy` and `scipy`. For the visualization in this tutorial we use [meshplot](https://github.com/skoch9/meshplot) which can be easily installed from Conda:\n", "```\n", - "conda install -c conda-forge meshplot \n", + "pip install https://github.com/skoch9/meshplot/archive/0.4.0.tar.gz \n", "```\n", "\n", "\n", diff --git a/tutorial/tut-chapter1.ipynb b/tutorial/tut-chapter1.ipynb index 9626b6ee..65f3647b 100644 --- a/tutorial/tut-chapter1.ipynb +++ b/tutorial/tut-chapter1.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 1: Discrete Geometric Quantities and Operators\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { diff --git a/tutorial/tut-chapter2.ipynb b/tutorial/tut-chapter2.ipynb index 6f6e8096..297687a3 100644 --- a/tutorial/tut-chapter2.ipynb +++ b/tutorial/tut-chapter2.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 2: Matrices and Linear Algebra\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { diff --git a/tutorial/tut-chapter3.ipynb b/tutorial/tut-chapter3.ipynb index 180f8840..57f6a77b 100644 --- a/tutorial/tut-chapter3.ipynb +++ b/tutorial/tut-chapter3.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 3: Shape deformation\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { diff --git a/tutorial/tut-chapter4.ipynb b/tutorial/tut-chapter4.ipynb index 350fde11..c058ed08 100644 --- a/tutorial/tut-chapter4.ipynb +++ b/tutorial/tut-chapter4.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 4: Parametrization\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { diff --git a/tutorial/tut-chapter5.ipynb b/tutorial/tut-chapter5.ipynb index 94d58d8b..739a230e 100644 --- a/tutorial/tut-chapter5.ipynb +++ b/tutorial/tut-chapter5.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 5: External libraries\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { diff --git a/tutorial/tut-chapter6.ipynb b/tutorial/tut-chapter6.ipynb index 4aebfdb8..f4b48a22 100644 --- a/tutorial/tut-chapter6.ipynb +++ b/tutorial/tut-chapter6.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 6: Miscellaneous\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { diff --git a/tutorial/tut-chapter7.ipynb b/tutorial/tut-chapter7.ipynb index e255bbb1..e8aa2c80 100644 --- a/tutorial/tut-chapter7.ipynb +++ b/tutorial/tut-chapter7.ipynb @@ -5,10 +5,8 @@ "metadata": {}, "source": [ "# Chapter 7: Skinned Shape Deformation\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)" + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)" ] }, { @@ -34,7 +32,7 @@ "import igl\n", "import scipy as sp\n", "import numpy as np\n", - "import scripts.meshplot as mp\n", + "import meshplot as mp\n", "\n", "import os\n", "\n", diff --git a/tutorial/tutorials.ipynb b/tutorial/tutorials.ipynb index c434a390..aa5b8bd8 100644 --- a/tutorial/tutorials.ipynb +++ b/tutorial/tutorials.ipynb @@ -5,13 +5,9 @@ "metadata": {}, "source": [ "## Libigl Tutorials\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge)\n", + "[![PyPI version](https://badge.fury.io/py/libigl.svg)](https://pypi.org/project/libigl/)\n", "\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/downloads.svg)](https://anaconda.org/conda-forge/igl)\n", - "\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/platforms.svg)](https://anaconda.org/conda-forge/igl)\n", - "\n", - "[![Anaconda-Server Badge](https://anaconda.org/conda-forge/igl/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/igl)\n", + "[![buildwheels](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml/badge.svg)](https://github.com/libigl/libigl-python-bindings/actions/workflows/wheels.yml?query=branch%3Amain)\n", "\n", "![](images/libigl-logo.jpg)\n", "\n", @@ -42,15 +38,15 @@ "\n", "\n", "### Downloading Libigl\n", - "Libigl can be downloaded from [Conda forge](https://anaconda.org/conda-forge/igl):\n", + "Libigl can be downloaded from [PyPI](https://pypi.org/project/libigl/):\n", "```\n", - "conda install -c conda-forge igl \n", + "python -m pip install libigl \n", "```\n", "\n", "\n", - "All of libigl functionality depends only on `numpy` and `scipy`. For the visualization in this tutorial we use [meshplot](https://anaconda.org/conda-forge/meshplot) which can be easily installed from Conda:\n", + "All of libigl functionality depends only on `numpy` and `scipy`. For the visualization in this tutorial we use [meshplot](https://github.com/skoch9/meshplot) which can be easily installed from Conda:\n", "```\n", - "conda install -c conda-forge meshplot \n", + "python -m pip install https://github.com/skoch9/meshplot/archive/0.4.0.tar.gz \n", "```\n", "\n", "\n", @@ -70,11 +66,11 @@ "\n", "import os\n", "root_folder = os.getcwd()\n", - "#root_folder = os.path.join(os.getcwd(), \"tutorial\")", + "#root_folder = os.path.join(os.getcwd(), \"tutorial\")\n", "data_folder = os.path.join(root_folder,\"/data\")\n", "# pip install gitpython\n", "from git import Repo\n", - "if not os.path.isdir(data_folder):\n" + "if not os.path.isdir(data_folder):\n", " Repo.clone_from(\"https://github.com/libigl/libigl-tutorial-data.git\", data_folder)\n", "\n" ]