Skip to main content

N-dimensional B-spline library for numerical mechanics and geometry

Project description

bsplyne

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:

pip install bsplyne

Install the library with recommended visualization features (additionally install pyvista):

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:

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 for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bsplyne-1.0.6.tar.gz (60.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bsplyne-1.0.6-py3-none-any.whl (57.6 kB view details)

Uploaded Python 3

File details

Details for the file bsplyne-1.0.6.tar.gz.

File metadata

  • Download URL: bsplyne-1.0.6.tar.gz
  • Upload date:
  • Size: 60.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for bsplyne-1.0.6.tar.gz
Algorithm Hash digest
SHA256 ed40928d30eeb69baf1d127c028565d470e86d5e43555a6bfac9316442cb0fa0
MD5 dcf8b529d88691f31cf2281075806e5b
BLAKE2b-256 28e60fac4e8fd71cab579819d99d7d88e43523bbf98f815b74bb22f1e7b7d630

See more details on using hashes here.

File details

Details for the file bsplyne-1.0.6-py3-none-any.whl.

File metadata

  • Download URL: bsplyne-1.0.6-py3-none-any.whl
  • Upload date:
  • Size: 57.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for bsplyne-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d5b10ecf3c31a5842e6f2d28157d99fa6679f16db7dd81ce8587190480380558
MD5 b712b1b79cc987b9d5e4fcfca8734949
BLAKE2b-256 da73a60d8cff874b134441011a6eae987bcfbef19a525f087734228172ca3f86

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page