bsplyne 1.0.0__tar.gz

bsplyne-1.0.0/LICENSE.txt

@@ -0,0 +1,70 @@
+
+  CeCILL FREE SOFTWARE LICENSE AGREEMENT
+
+Version 2.1 dated 2013-06-21
+
+
+    Notice
+
+This Agreement is a Free Software license agreement that is the result
+of discussions between its authors in order to ensure compliance with
+the two main principles guiding its drafting:
+
+  * firstly, compliance with the principles governing the distribution
+    of Free Software: access to source code, broad rights granted to users,
+  * secondly, the election of a governing law, French law, with which it
+    is conformant, both as regards the law of torts and intellectual
+    property law, and the protection that it offers to both authors and
+    holders of the economic rights over software.
+
+The authors of the CeCILL (for Ce[a] C[nrs] I[nria] L[ogiciel] L[ibre]) 
+license are: 
+
+Commissariat à l'énergie atomique et aux énergies alternatives - CEA, a
+public scientific, technical and industrial research establishment,
+having its principal place of business at 25 rue Leblanc, immeuble Le
+Ponant D, 75015 Paris, France.
+
+Centre National de la Recherche Scientifique - CNRS, a public scientific
+and technological establishment, having its principal place of business
+at 3 rue Michel-Ange, 75794 Paris cedex 16, France.
+
+Institut National de Recherche en Informatique et en Automatique -
+Inria, a public scientific and technological establishment, having its
+principal place of business at Domaine de Voluceau, Rocquencourt, BP
+105, 78153 Le Chesnay cedex, France.
+
+
+    Preamble
+
+The purpose of this Free Software license agreement is to grant users
+the right to modify and redistribute the software governed by this
+license within the framework of an open source distribution model.
+
+The exercising of this right is conditional upon certain obligations for
+users so as to preserve this status for all subsequent redistributions.
+
+In consideration of access to the source code and the rights to copy,
+modify and redistribute granted by the license, users are provided only
+with a limited warranty and the software's author, the holder of the
+economic rights, and the successive licensors only have limited liability.
+
+In this respect, the risks associated with loading, using, modifying
+and/or developing or reproducing the software by the user are brought to
+the user's attention, given its Free Software status, which may make it
+complicated to use, with the result that its use is reserved for
+developers and experienced professionals having in-depth computer
+knowledge. Users are therefore encouraged to load and test the
+suitability of the software as regards their requirements in conditions
+enabling the security of their systems and/or data to be ensured and,
+more generally, to use and operate it in the same conditions of
+security. This Agreement may be freely reproduced and published,
+provided it is not altered, and that no provisions are either added or
+removed herefrom.
+
+This Agreement may apply to any or all software for which the holder of
+the economic rights decides to submit the use thereof to its provisions.
+
+Frequently asked questions can be found on the official website of the
+CeCILL licenses family (http://www.cecill.info/index.en.html) for any 
+necessary clarification.

bsplyne-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include *.jpg
+include *.txt
+recursive-include tests *.py

bsplyne-1.0.0/PKG-INFO

@@ -0,0 +1,91 @@
+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/README.md

@@ -0,0 +1,63 @@
+# 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/bsplyne/__init__.py

@@ -0,0 +1,55 @@
+"""
+.. include:: ../README.md
+"""
+
+from bsplyne.b_spline_basis import BSplineBasis
+
+# BSplineBasis.__module__ = "bsplyne.b_spline_basis"
+from bsplyne.b_spline import BSpline
+
+# BSpline.__module__ = "bsplyne.b_spline"
+from bsplyne.multi_patch_b_spline import (
+    MultiPatchBSplineConnectivity,
+    CouplesBSplineBorder,
+)
+
+# MultiPatchBSplineConnectivity.__module__ = "bsplyne.multi_patch_b_spline"
+# CouplesBSplineBorder.__module__ = "bsplyne.multi_patch_b_spline"
+from bsplyne.geometries_in_3D import (
+    scale_rotate_translate,
+    new_quarter_circle,
+    new_circle,
+    new_disk,
+    new_degenerated_disk,
+    new_quarter_pipe,
+    new_pipe,
+    new_quarter_cylinder,
+    new_cylinder,
+    new_degenerated_cylinder,
+    new_closed_circle,
+    new_closed_disk,
+    new_closed_pipe,
+    new_closed_cylinder,
+    new_quarter_strut,
+    new_cube,
+)
+
+# scale_rotate_translate.__module__ = "bsplyne.geometries_in_3D"
+# new_quarter_circle.__module__ = "bsplyne.geometries_in_3D"
+# new_circle.__module__ = "bsplyne.geometries_in_3D"
+# new_disk.__module__ = "bsplyne.geometries_in_3D"
+# new_degenerated_disk.__module__ = "bsplyne.geometries_in_3D"
+# new_quarter_pipe.__module__ = "bsplyne.geometries_in_3D"
+# new_pipe.__module__ = "bsplyne.geometries_in_3D"
+# new_quarter_cylinder.__module__ = "bsplyne.geometries_in_3D"
+# new_cylinder.__module__ = "bsplyne.geometries_in_3D"
+# new_degenerated_cylinder.__module__ = "bsplyne.geometries_in_3D"
+# new_closed_circle.__module__ = "bsplyne.geometries_in_3D"
+# new_closed_disk.__module__ = "bsplyne.geometries_in_3D"
+# new_closed_pipe.__module__ = "bsplyne.geometries_in_3D"
+# new_closed_cylinder.__module__ = "bsplyne.geometries_in_3D"
+# new_quarter_strut.__module__ = "bsplyne.geometries_in_3D"
+# new_cube.__module__ = "bsplyne.geometries_in_3D"
+from bsplyne.parallel_utils import parallel_blocks
+
+# parallel_blocks.__module__ = "bsplyne.parallel_utils"