From 85d01bb788abed69dfd2cc903da422c848a3c39d Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Tue, 27 Aug 2024 19:41:20 +0900 Subject: [PATCH 1/8] Update usage to a link of sphinx-gallery --- README.md | 78 +------------------------------------------------------ 1 file changed, 1 insertion(+), 77 deletions(-) diff --git a/README.md b/README.md index 22eeb6a3..9ae240fc 100644 --- a/README.md +++ b/README.md @@ -36,83 +36,7 @@ pip install scikit-gmsh ## Usage -```python -import skgmsh as sg -``` - -Now, let's define geometry. - -```python -shell = [(0, 0, 0), (0, 10, 0), (10, 10, 0), (10, 0, 0), (0, 0, 0)] -holes = [[(2, 2, 0), (2, 4, 0), (4, 4, 0), (4, 2, 0), (2, 2, 0)]] -``` - -We can then generate a 2D mesh. - -```python -alg = sg.Delaunay2D(shell=shell, holes=holes) -mesh = alg.mesh -``` - -To visualize the model, we can use PyVista. - -```python -mesh.plot(show_edges=True, cpos="xy") -``` - -

- -

- -If you want to set the cell size, you can do so. - -```python -alg.cell_size = 0.5 -alg.mesh.plot(show_edges=True, cpos="xy") -``` - -

- -

- -We can also generate a 3D mesh. - -```python -source = pv.Cube() -alg = sg.Delaunay3D(edge_source=source, target_sizes=0.2) -``` - -```python -plotter = pv.Plotter() -_ = plotter.add_mesh( - alg.mesh, - show_edges=True, - line_width=1, - color="aliceblue", - lighting=False, - edge_color="gray", -) -_ = plotter.add_mesh(source.extract_all_edges(), line_width=4, color="gray") -_ = plotter.add_box_axes() -plotter.show() -``` - -

- -

- -We can clip a mesh by a plane by specifying the origin and normal. -See [clip_with_surface_example](https://docs.pyvista.org/examples/01-filter/clipping-with-surface#clip-with-surface-example) for more examples using this filter. - -```python -clipped = delaunay_3d.mesh.clip( - origin=(0.0, 0.0, 0.0), normal=(0.0, 0.0, 1.0), crinkle=True -) -``` - -

- -

+![pyvista_banner_small](https://github.com/pyvista/pyvista/raw/main/doc/source/_static/pyvista_banner_small.png) ## Other Resources From 99683434a4ad33aa0a143a23620b94f5b9f698a8 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Wed, 28 Aug 2024 10:37:40 +0900 Subject: [PATCH 2/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ae240fc..1dd0f4d5 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/ pip install scikit-gmsh ``` -## Usage +## Gallery ![pyvista_banner_small](https://github.com/pyvista/pyvista/raw/main/doc/source/_static/pyvista_banner_small.png) From 796f674440ec8db9bd9624fe7cb446b4f82e7d74 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Wed, 28 Aug 2024 11:18:38 +0900 Subject: [PATCH 3/8] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1dd0f4d5..75df82db 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,9 @@ Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/ pip install scikit-gmsh ``` -## Gallery +## Highlights + +Head over to the [Quick Examples](http://docs.pyvista.org/examples/index.html) page in the docs to explore our gallery of examples showcasing what scikit-gmsh can do. ![pyvista_banner_small](https://github.com/pyvista/pyvista/raw/main/doc/source/_static/pyvista_banner_small.png) From 8a09dd06bb1cf0fd5aa18dfcf0290249dc728a1d Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Wed, 28 Aug 2024 17:38:07 +0900 Subject: [PATCH 4/8] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 75df82db..51cd2690 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,9 @@ Enjoying scikit-gmsh? Show your support with a [GitHub star](https://github.com/ pip install scikit-gmsh ``` -## Highlights - -Head over to the [Quick Examples](http://docs.pyvista.org/examples/index.html) page in the docs to explore our gallery of examples showcasing what scikit-gmsh can do. +## Gallery +Check out the example galleries organized by subject here: ![pyvista_banner_small](https://github.com/pyvista/pyvista/raw/main/doc/source/_static/pyvista_banner_small.png) ## Other Resources From a4d2c393554d2f15ab582d5c69fde388c498b91c Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 30 Aug 2024 13:09:29 +0900 Subject: [PATCH 5/8] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 51cd2690..f623619b 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,7 @@ pip install scikit-gmsh ## Gallery -Check out the example galleries organized by subject here: -![pyvista_banner_small](https://github.com/pyvista/pyvista/raw/main/doc/source/_static/pyvista_banner_small.png) +Check out the example galleries organized by subject [here](https://scikit-gmsh.readthedocs.io/en/latest/examples/index.html). ## Other Resources From c123ecd956e7b05d445d0ce6b0cd3eff9492b6cf Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 30 Aug 2024 13:18:50 +0900 Subject: [PATCH 6/8] Update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f623619b..937bd793 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,28 @@ pip install scikit-gmsh ## Gallery -Check out the example galleries organized by subject [here](https://scikit-gmsh.readthedocs.io/en/latest/examples/index.html). +Check out the example galleries organized by subject here: +

+ +

## Other Resources From b2906bf0d8e0f937d29a0351889e435e581f8143 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 30 Aug 2024 04:19:00 +0000 Subject: [PATCH 7/8] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 937bd793..62d26ee5 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,7 @@ pip install scikit-gmsh ## Gallery Check out the example galleries organized by subject here: +

Date: Sat, 31 Aug 2024 18:56:17 +0900 Subject: [PATCH 8/8] Update README.md --- README.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/README.md b/README.md index b125a5a7..84f9a7e3 100644 --- a/README.md +++ b/README.md @@ -33,25 +33,7 @@ pip install scikit-gmsh Check out the example galleries organized by subject here:

- +

## Other Resources