NURBS-Python v5.x Documentation

Welcome to the NURBS-Python (geomdl) v5.x documentation!

NURBS-Python (geomdl) is a cross-platform (pure Python), object-oriented B-Spline and NURBS library. It is compatible with Python versions 2.7.x, 3.4.x and later. It supports rational and non-rational curves, surfaces and volumes.

NURBS-Python (geomdl) provides easy-to-use data structures for storing geometry descriptions in addition to the fundamental and advanced evaluation algorithms.

This documentation is organized into a couple sections:

• Introduction
• Using the Library
• Modules

Introduction

• Motivation
  • References
  • Author
• Citing NURBS-Python
  • Article
  • BibTex
  • Licenses
• Questions and Answers
  • What is NURBS?
  • Why NURBS-Python?
  • Why two packages on PyPI?
  • Minimum Requirements
  • Help and Support
  • How can I add a new feature?
  • Why doesn’t NURBS-Python have XYZ feature?
  • Documentation references to the text books
  • Why doesn’t NURBS-Python follow the algorithms?
  • NURBS-Python API changes
• Contributing
  • Bugs reports
  • Pull requests
  • Feature requests
  • Questions and comments

Using the Library

• Installation and Testing
  • Install via Pip
  • Install via Conda
  • Manual Install
  • Development Mode
  • Checking Installation
  • Testing
  • Compile with Cython
  • Docker Containers
• Basics
  • Working with the curves
  • Working with the surfaces
  • Working with the volumes
• Examples Repository
• Loading and Saving Data
• Supported File Formats
  • Text Files
  • Comma-Separated (CSV)
  • OBJ Format
  • STL Format
  • Object File Format (OFF)
  • Custom Formats (libconfig, YAML, JSON)
  • Using Templates
• Compatibility
• Surface Generator
• Knot Refinement
• Curve & Surface Fitting
  • Interpolation
  • Approximation
• Visualization
  • Examples
• Splitting and Decomposition
  • Splitting
  • Bézier Decomposition
• Exporting Plots as Image Files

Modules

• Core Modules
  • User API
    • B-Spline Geometry
    • NURBS Geometry
    • Freeform Geometry
    • Geometry Containers
    • Geometric Operations
    • Compatibility and Conversion
    • Geometry Converters
    • Geometry Constructors and Extractors
    • Curve and Surface Fitting
    • Tessellation
    • Trimming
    • Sweeping
    • Import and Export Data
  • Geometry Generators
    • Knot Vector Generator
    • Control Points Manager
    • Surface Generator
  • Advanced API
    • Geometry Base
    • Evaluators
    • Utility Functions
    • Voxelization
    • Geometric Entities
    • Ray Module
• Visualization Modules
  • Visualization Base
    • Class Reference
  • Matplotlib Implementation
    • Class Reference
  • Plotly Implementation
    • Class Reference
  • VTK Implementation
    • Class Reference
• Command-line Application
  • Installation
  • Documentation
  • References
• Shapes Module
  • Installation
  • Documentation
  • References
• Rhino Importer/Exporter
  • Use Cases
  • Installation
  • Using with geomdl
  • References
• ACIS Importer
  • Use Cases
  • Installation
  • Using with geomdl
  • References