bsplyne 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

bsplyne/__init__.py

@@ -1,5 +1,5 @@
 """
-.. include:: ../README.md
+.. include:: ../../README.md
 """
 
 from bsplyne.b_spline_basis import BSplineBasis

bsplyne/b_spline.py

@@ -1,6 +1,7 @@
 import os
 from typing import Iterable, Literal, Union
 import json, pickle
+import warnings
 
 import numpy as np
 import scipy.sparse as sps
@@ -1943,6 +1944,11 @@ class BSpline:
                 show,
             )
         else:
+            if not _can_visualize_pyvista:
+                warnings.warn(
+                    "Can't use PyVista. Fallback to Matplotlib plotter. "
+                    "For better visualization, install PyVista."
+                )
             return self.plotMPL(
                 ctrl_pts,
                 n_eval_per_elem,

bsplyne/b_spline_basis.py

@@ -511,7 +511,7 @@ class BSplineBasis:
             Row index of D.
         j : int
             Column index of D.
-        new_knot : numpy.array of float
+        new_knot : np.ndarray[np.floating]
             New knot vector to use.
         p : int
             Degree of the BSpline.
@@ -547,7 +547,7 @@ class BSplineBasis:
 
         Parameters
         ----------
-        new_knot : numpy.array of float
+        new_knot : np.ndarray[np.floating]
             The new knot vector for the knot insertion.
 
         Returns
@@ -802,7 +802,7 @@ def _funcNElemOneXi(i, p, knot, xi):
         Index of the basis function wanted.
     p : int
         Degree of the BSpline evaluated.
-    knot : numpy.array of float
+    knot : np.ndarray[np.floating]
         Knot vector of the BSpline basis.
     xi : float
         Value in the parametric space at which the BSpline is evaluated.
@@ -846,7 +846,7 @@ def _funcDNElemOneXi(i, p, knot, xi, k):
         Index of the basis function wanted.
     p : int
         Degree of the BSpline evaluated.
-    knot : numpy.array of float
+    knot : np.ndarray[np.floating]
         Knot vector of the BSpline basis.
     xi : float
         Value in the parametric space at which the BSpline is evaluated.
@@ -904,7 +904,7 @@ def _findElem(p, m, n, knot, xi):
         Last index of the knot vector.
     n : int
         Last index of the basis.
-    knot : numpy.array of float
+    knot : np.ndarray[np.floating]
         Knot vector of the BSpline basis.
     xi : float
         Value in the parametric space.
@@ -955,16 +955,16 @@ def _DN(p, m, n, knot, XI, k):
         Last index of the knot vector.
     n : int
         Last index of the basis.
-    knot : numpy.array of float
+    knot : np.ndarray[np.floating]
         Knot vector of the BSpline basis.
-    XI : numpy.array of float
+    XI : np.ndarray[np.floating]
         Values in the parametric space at which the BSpline is evaluated.
     k : int
         `k`-th derivative of the BSpline evaluated. The default is 0.
 
     Returns
     -------
-    (vals, row, col) : (numpy.array of float, numpy.array of int, numpy.array of int)
+    (vals, row, col) : (np.ndarray[np.floating], np.ndarray[np.integer], np.ndarray[np.integer])
         Values and indices of the `k`-th derivative matrix of the BSpline
         basis functions in the columns for each value of `XI` in the rows.
 

bsplyne/multi_patch_b_spline.py

@@ -62,9 +62,9 @@ class MultiPatchBSplineConnectivity:
 
     Attributes
     ----------
-    unique_nodes_inds : numpy.ndarray of int
+    unique_nodes_inds : np.ndarray[np.integer]
         The indices of the unique representation needed to create the unpacked one.
-    shape_by_patch : numpy.ndarray of int
+    shape_by_patch : np.ndarray[np.integer]
         The shape of the separated nodes by patch.
     nb_nodes : int
         The total number of unpacked nodes.
@@ -88,9 +88,9 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        unique_nodes_inds : numpy.ndarray of int
+        unique_nodes_inds : np.ndarray[np.integer]
             The indices of the unique representation needed to create the unpacked one.
-        shape_by_patch : numpy.ndarray of int
+        shape_by_patch : np.ndarray[np.integer]
             The shape of the separated nodes by patch.
         nb_unique_nodes : int
             The total number of unique nodes.
@@ -108,10 +108,10 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        nodes_couples : numpy.ndarray of int
+        nodes_couples : np.ndarray[np.integer]
             Couples of indices of unpacked nodes that are considered the same.
             Its shape should be (# of couples, 2)
-        shape_by_patch : numpy.ndarray of int
+        shape_by_patch : np.ndarray[np.integer]
             The shape of the separated nodes by patch.
 
         Returns
@@ -142,7 +142,7 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        separated_ctrlPts : list of numpy.ndarray of float
+        separated_ctrlPts : list of np.ndarray[np.floating]
             Control points of every patch to be compared in the separated
             representation. Every array is of shape :
             (``NPh``, nb elem for dim 1, ..., nb elem for dim ``npa``)
@@ -217,13 +217,13 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        unique_field : numpy.ndarray
+        unique_field : np.ndarray
             The unique representation. Its shape should be :
             (field, shape, ..., `self`.`nb_unique_nodes`)
 
         Returns
         -------
-        unpacked_field : numpy.ndarray
+        unpacked_field : np.ndarray
             The unpacked representation. Its shape is :
             (field, shape, ..., `self`.`nb_nodes`)
         """
@@ -236,7 +236,7 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        unpacked_field : numpy.ndarray
+        unpacked_field : np.ndarray
             The unpacked representation. Its shape should be :
             (field, shape, ..., `self`.`nb_nodes`)
         method: str
@@ -244,7 +244,7 @@ class MultiPatchBSplineConnectivity:
 
         Returns
         -------
-        unique_nodes : numpy.ndarray
+        unique_nodes : np.ndarray
             The unique representation. Its shape is :
             (field, shape, ..., `self`.`nb_unique_nodes`)
         """
@@ -273,13 +273,13 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        unpacked_field : numpy.ndarray
+        unpacked_field : np.ndarray
             The unpacked representation. Its shape is :
             (field, shape, ..., `self`.`nb_nodes`)
 
         Returns
         -------
-        separated_field : list of numpy.ndarray
+        separated_field : list of np.ndarray
             The separated representation. Every array is of shape :
             (field, shape, ..., nb elem for dim 1, ..., nb elem for dim `npa`)
         """
@@ -300,13 +300,13 @@ class MultiPatchBSplineConnectivity:
 
         Parameters
         ----------
-        separated_field : list of numpy.ndarray
+        separated_field : list of np.ndarray
             The separated representation. Every array is of shape :
             (field, shape, ..., nb elem for dim 1, ..., nb elem for dim `npa`)
 
         Returns
         -------
-        unpacked_field : numpy.ndarray
+        unpacked_field : np.ndarray
             The unpacked representation. Its shape is :
             (field, shape, ..., `self`.`nb_nodes`)
         """
@@ -334,7 +334,7 @@ class MultiPatchBSplineConnectivity:
 
         Returns
         -------
-        unique_field_indices : numpy.ndarray of int or list of numpy.ndarray of int
+        unique_field_indices : np.ndarray[np.integer] or list of np.ndarray[np.integer]
             The unique, unpacked or separated representation of a field's unique indices.
             If unique, its shape is (*`field_shape`, `self`.`nb_unique_nodes`).
             If unpacked, its shape is : (*`field_shape`, `self`.`nb_nodes`).
@@ -366,7 +366,7 @@ class MultiPatchBSplineConnectivity:
 
         Returns
         -------
-        duplicate_nodes_mask : numpy.ndarray
+        duplicate_nodes_mask : np.ndarray
             Boolean mask of shape (nb_nodes,) where True indicates a node is duplicated
             across multiple patches and False indicates it appears only once.
         """
@@ -391,7 +391,7 @@ class MultiPatchBSplineConnectivity:
             Connectivity information for the border patches.
         border_splines : list[BSpline]
             Array of B-spline patches representing the borders.
-        border_unique_to_self_unique_connectivity : numpy.ndarray of int
+        border_unique_to_self_unique_connectivity : np.ndarray[np.integer]
             Array mapping border unique nodes to original unique nodes.
 
         Raises
@@ -484,7 +484,7 @@ class MultiPatchBSplineConnectivity:
             Connectivity information for the border patches.
         border_splines : list[BSpline]
             Array of B-spline patches representing the borders.
-        border_unique_to_self_unique_connectivity : numpy.ndarray of int
+        border_unique_to_self_unique_connectivity : np.ndarray[np.integer]
             Array mapping border unique nodes to original unique nodes.
 
         Raises
@@ -649,7 +649,7 @@ class MultiPatchBSplineConnectivity:
         ----------
         splines : list[BSpline]
             Array of B-spline patches to subset.
-        patches_to_keep : numpy.array of int
+        patches_to_keep : np.ndarray[np.integer]
             Indices of patches to keep in the subset.
 
         Returns
@@ -658,7 +658,7 @@ class MultiPatchBSplineConnectivity:
             New connectivity object containing only the selected patches.
         new_splines : list[BSpline]
             Array of B-spline patches for the selected patches.
-        new_unique_to_self_unique_connectivity : numpy.ndarray of int
+        new_unique_to_self_unique_connectivity : np.ndarray[np.integer]
             Array mapping new unique nodes to original unique nodes.
         """
         new_splines = splines[patches_to_keep]

bsplyne/save_utils.py

@@ -3,7 +3,7 @@ import meshio as io
 from typing import Iterable
 from functools import reduce
 import os
-import xml
+from xml.dom import minidom
 
 
 def writePVD(fileName: str, groups: dict[str, dict]):
@@ -32,7 +32,7 @@ def writePVD(fileName: str, groups: dict[str, dict]):
     None
     """
     rep, fname = os.path.split(fileName)
-    pvd = xml.dom.minidom.Document()
+    pvd = minidom.Document()
     pvd_root = pvd.createElementNS("VTK", "VTKFile")
     pvd_root.setAttribute("type", "Collection")
     pvd_root.setAttribute("version", "0.1")

bsplyne-1.0.2.dist-info/METADATA

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: bsplyne
+Version: 1.0.2
+Summary: N-dimensional B-spline library for numerical mechanics and geometry
+Author-email: Dorian Bichet <dbichet@insa-toulouse.fr>
+Project-URL: Homepage, https://github.com/Dorian210/bsplyne
+Project-URL: Repository, https://github.com/Dorian210/bsplyne
+Project-URL: Issues, https://github.com/Dorian210/bsplyne/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
+Classifier: Topic :: Scientific/Engineering
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy>=1.20
+Requires-Dist: numba>=0.55
+Requires-Dist: scipy>=1.8
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: meshio>=5.0
+Requires-Dist: tqdm>=4.60
+Provides-Extra: viz
+Requires-Dist: pyvista>=0.41; extra == "viz"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: wkhtmltopdf; extra == "docs"
+Requires-Dist: pdoc>=12.0; extra == "docs"
+Dynamic: license-file
+
+# bsplyne
+
+<p align="center">
+  <img src="docs/logo.png" width="500" />
+</p>
+
+**bsplyne** is a Python library for working with N-dimensional B-splines, with a focus on numerical mechanics and geometry.
+It implements the Cox–de Boor algorithm for basis evaluation, order elevation, knot insertion, and provides tools for handling
+multi-patch B-spline structures. Visualization and export utilities (e.g. Paraview) are also included.
+
+---
+
+## Installation
+
+### Using pip
+
+Install the core library:
+
+```bash
+pip install bsplyne
+```
+
+Install the library **with recommended visualization features** (additionally install `pyvista`):
+
+```bash
+pip install bsplyne[viz]
+```
+
+> Note: choose either the core (`bsplyne`) or the visualization (`bsplyne[viz]`) installation, not both.
+
+### Using conda (conda-forge)
+
+Install the core library:
+
+```bash
+conda install -c conda-forge bsplyne
+```
+
+Optional: install PyVista to enable visualization features:
+
+```bash
+conda install -c conda-forge pyvista
+```
+
+### From source (development mode)
+
+Clone the repository and install:
+
+```bash
+git clone https://github.com/Dorian210/bsplyne
+cd bsplyne
+pip install -e .       # core
+pip install -e .[viz]  # with visualization
+```
+
+---
+
+## Dependencies
+
+Core dependencies are handled automatically by `pip` or `conda`:
+
+- numpy
+- numba
+- scipy
+- matplotlib
+- meshio
+- tqdm
+
+Optional visualization:
+
+- pyvista (for 3D visualization)
+
+---
+
+## Main Modules
+
+- **BSplineBasis**  
+  Evaluation of B-spline basis functions using the Cox–de Boor recursion formula.
+
+- **BSpline**  
+  Construction and manipulation of N-dimensional B-splines, including order elevation and knot insertion.
+
+- **MultiPatchBSplineConnectivity**  
+  Management of connectivity between multiple B-spline patches.
+
+- **CouplesBSplineBorder**  
+  Utilities for coupling B-spline borders (experimental / less documented).
+
+---
+
+## Tutorials
+
+A step-by-step introduction to **bsplyne** is provided in:
+
+```
+examples/tutorial/
+```
+
+These scripts are designed as a progressive entry point to the library and cover:
+
+1. B-spline basis functions  
+2. Curve construction  
+3. Surface generation  
+4. Least-squares fitting  
+5. Multi-patch geometries  
+6. Export to Paraview  
+
+In addition, a **comprehensive PDF guide** (`tp_bsplyne.pdf`) is included in the tutorials directory, providing a hands-on introduction to the library for new users.  
+It explains the workflow, the main modules, and practical usage examples.
+
+---
+
+## Examples
+
+Additional standalone examples are available in the `examples/` directory, including:
+
+- Curves and surfaces
+- Order elevation and knot insertion
+- Visualization with Matplotlib
+- Export to Paraview
+
+---
+
+## Documentation
+
+The full API documentation is available online:
+
+https://dorian210.github.io/bsplyne/
+
+The documentation is generated from the source code docstrings and reflects the latest published version.
+
+---
+
+## Contributions
+
+This project is primarily developed for research purposes.
+While I am not actively reviewing external contributions, bug reports and suggestions are welcome via the issue tracker.
+
+---
+
+## License
+
+This project is licensed under the **CeCILL License**.  
+See [LICENSE.txt](LICENSE.txt) for details.

bsplyne-1.0.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+bsplyne/__init__.py,sha256=JyAdwOKZ1G2zAtT_bWmXCvjIj-5beIEWSzoqZhsZotw,1902
+bsplyne/b_spline.py,sha256=i3GHwVs9gEZP28UVo4Bub_SsAxrlN5oaTi111pTzt9s,110352
+bsplyne/b_spline_basis.py,sha256=vldxFkdWrsXFmwGPBFprmUyPYPfwgeYNYmULXQlN-Jc,35347
+bsplyne/geometries_in_3D.py,sha256=krQPNZEg-PZCTnlhd1YrJjwCwv7R9T7oAxxlZJms_Zs,36519
+bsplyne/multi_patch_b_spline.py,sha256=zPL4hax-otlRSVft7SteQiWbjk5qN3q-AsG-rAtqP8Y,75925
+bsplyne/my_wide_product.py,sha256=JqFy2s3ks0wKf4iq22NyzrZo-3Uo7ita-r6fGcGEfEE,5678
+bsplyne/parallel_utils.py,sha256=M0Tuy8wA3AYltsnr_iYOnREWRGZnPxavq9cpWaEC_lU,15326
+bsplyne/save_utils.py,sha256=DgIWoLmka75AprbSQnZwAUA0ox2winSOmW9UNBeFU_s,5032
+bsplyne-1.0.2.dist-info/licenses/LICENSE.txt,sha256=NuJeFieCkXCWPQlUUkzn5TrngzZmXp09-Q8fk15_r6A,3196
+bsplyne-1.0.2.dist-info/METADATA,sha256=STeNkrOZNFPL5xW5Fa__e3HjTmMS6mE9jaqhlLZH7K4,4518
+bsplyne-1.0.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+bsplyne-1.0.2.dist-info/top_level.txt,sha256=Mwj9pTQb41GC_guOzmpvMcdkXeeAIWF6VtZcXghgx0c,8
+bsplyne-1.0.2.dist-info/RECORD,,

bsplyne-1.0.0.dist-info/METADATA

@@ -1,91 +0,0 @@
-Metadata-Version: 2.4
-Name: bsplyne
-Version: 1.0.0
-Summary: A package for N dimensions B-splines.
-Home-page: https://github.com/Dorian210/bsplyne
-Author: Dorian Bichet
-Author-email: dbichet@insa-toulouse.fr
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Classifier: License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: numpy
-Requires-Dist: numba
-Requires-Dist: scipy
-Requires-Dist: matplotlib
-Requires-Dist: meshio
-Requires-Dist: tqdm
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: summary
-
-# bsplyne
-
-<p align="center">
-  <img src=docs/logo.png width="500" />
-</p>
-
-**bsplyne** is a Python library for working with N-dimensional B-splines. It implements the Cox-de Boor algorithm for basis evaluation, order elevation, knot insertion, and provides a connectivity class for multi-patch structures. Additionally, it includes visualization tools with export capabilities to Paraview.
-
-## Installation
-
-Since **bsplyne** is not yet on PyPI, you can install it locally as follows:
-
-```bash
-git clone https://github.com/Dorian210/bsplyne
-cd bsplyne
-pip install -e .
-```
-
-### Dependencies
-Make sure you have the following dependencies installed:
-- `numpy`
-- `numba`
-- `scipy`
-- `matplotlib`
-- `meshio`
-- `tqdm`
-
-## Main Modules
-
-- **BSplineBasis**  
-  Implements B-spline basis function evaluation using the Cox-de Boor recursion formula.
-  
-- **BSpline**  
-  Provides methods for creating and manipulating N-dimensional B-splines, including order elevation and knot insertion.
-  
-- **MultiPatchBSplineConnectivity**  
-  Manages the connectivity between multiple N-dimensional B-spline patches.
-  
-- **CouplesBSplineBorder** (less documented)  
-  Handles coupling between B-spline borders.
-
-## Examples
-
-Several example scripts demonstrating the usage of **bsplyne** can be found in the `examples/` directory. These scripts cover:
-- Basis evaluation on a curved line
-- Plotting with Matplotlib
-- Order elevation
-- Knot insertion
-- Surface examples
-- Exporting to Paraview
-
-## Documentation
-
-The full API documentation is available in the `docs/` directory of the project or via the [online documentation portal](https://dorian210.github.io/bsplyne/).
-
-## Contributions
-
-At the moment, I am not actively reviewing contributions. However, if you encounter issues or have suggestions, feel free to open an issue.
-
-## License
-
-This project is licensed under the [CeCILL License](LICENSE.txt).
-

bsplyne-1.0.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-bsplyne/__init__.py,sha256=sajGBdm1-pu6iMgD-G_nimXrbXZsXwrJT6bjA_JyLO8,1899
-bsplyne/b_spline.py,sha256=CJYIS_kAJFOy1ay7kIOACyX1j20BkT9TRn1t1j8WkGU,110105
-bsplyne/b_spline_basis.py,sha256=J4vrGx-WcW7suZDJzvLr3zDQyGCCLAZlMbzuGeQ1fZ4,35315
-bsplyne/geometries_in_3D.py,sha256=krQPNZEg-PZCTnlhd1YrJjwCwv7R9T7oAxxlZJms_Zs,36519
-bsplyne/multi_patch_b_spline.py,sha256=4lsxS3m7EV_igfzOBjCKaB7Pd8pxI-ZHyLmnQRP4NhQ,75925
-bsplyne/my_wide_product.py,sha256=JqFy2s3ks0wKf4iq22NyzrZo-3Uo7ita-r6fGcGEfEE,5678
-bsplyne/parallel_utils.py,sha256=M0Tuy8wA3AYltsnr_iYOnREWRGZnPxavq9cpWaEC_lU,15326
-bsplyne/save_utils.py,sha256=p-gDHTAU4Fr8iI_yPfdrMHtEF6bOlgkm8b4yHxA5qtw,5023
-bsplyne-1.0.0.dist-info/licenses/LICENSE.txt,sha256=NuJeFieCkXCWPQlUUkzn5TrngzZmXp09-Q8fk15_r6A,3196
-bsplyne-1.0.0.dist-info/METADATA,sha256=5Gb889Dpk_bkCi3Pgds_5EintBhxWTNCREE7C4bNjkY,2690
-bsplyne-1.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-bsplyne-1.0.0.dist-info/top_level.txt,sha256=Mwj9pTQb41GC_guOzmpvMcdkXeeAIWF6VtZcXghgx0c,8
-bsplyne-1.0.0.dist-info/RECORD,,