bsplyne 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

bsplyne-1.0.3.dist-info/METADATA

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: bsplyne
+Version: 1.0.3
+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="https://raw.githubusercontent.com/Dorian210/bsplyne/main/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
+
+### From PyPI (recommended method)
+
+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.
+
+### 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`:
+
+- 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.1.dist-info → bsplyne-1.0.3.dist-info}/RECORD

@@ -6,8 +6,8 @@ bsplyne/multi_patch_b_spline.py,sha256=zPL4hax-otlRSVft7SteQiWbjk5qN3q-AsG-rAtqP
 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.1.dist-info/licenses/LICENSE.txt,sha256=NuJeFieCkXCWPQlUUkzn5TrngzZmXp09-Q8fk15_r6A,3196
-bsplyne-1.0.1.dist-info/METADATA,sha256=1su0tLWuOCrhCSstMAttLty7g3QFWMXXRbI2LiD548M,3154
-bsplyne-1.0.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-bsplyne-1.0.1.dist-info/top_level.txt,sha256=Mwj9pTQb41GC_guOzmpvMcdkXeeAIWF6VtZcXghgx0c,8
-bsplyne-1.0.1.dist-info/RECORD,,
+bsplyne-1.0.3.dist-info/licenses/LICENSE.txt,sha256=NuJeFieCkXCWPQlUUkzn5TrngzZmXp09-Q8fk15_r6A,3196
+bsplyne-1.0.3.dist-info/METADATA,sha256=oIblwsVhJE46z1LsVbJtQzkSAI4Nvb9iGyiO-lMf3Rs,4356
+bsplyne-1.0.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+bsplyne-1.0.3.dist-info/top_level.txt,sha256=Mwj9pTQb41GC_guOzmpvMcdkXeeAIWF6VtZcXghgx0c,8
+bsplyne-1.0.3.dist-info/RECORD,,

bsplyne-1.0.1.dist-info/METADATA

@@ -1,96 +0,0 @@
-Metadata-Version: 2.4
-Name: bsplyne
-Version: 1.0.1
-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"
-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. 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).
-