Questions and Answers¶
What is NURBS?¶
NURBS is an acronym for Non-Uniform Rational Basis Spline and it represents a mathematical model for generation of geometric shapes in a flexible way. It is a well-accepted industry standard and used as a basis for nearly all of the 3-dimensional modeling and CAD/CAM software packages as well as modeling and visualization frameworks.
Although the mathematical theory of behind the splines dates back to early 1900s, the spline theory in the way we know is coined by Isaac (Iso) Schoenberg and developed further by various researchers around the world.
The following books are recommended for individuals who prefer to investigate the technical details of NURBS:
Why NURBS-Python?¶
NURBS-Python started as a final project for M E 625 Surface Modeling course offered in 2016 Spring semester at Iowa State University. The main purpose of the project was development of a free and open-source, object-oriented, pure Python NURBS library and releasing it on the public domain. As an added challenge to the project, everything was developed using Python Standard Library but no other external modules.
In years, NURBS-Python has grown up to a self-contained and extensible general-purpose pure Python spline library with support for various computational geometry and linear algebra algorithms. Apart from the computational side, user experience was also improved by introduction of visualization and CAD exchange modules.
NURBS-Python is a user-friendly library, regardless of the mathematical complexity of the splines. To give a head start, it comes with 40+ examples for various use cases. It also provides several extension modules for
- Using the library directly from the command-line
- Generating common spline shapes
- Rhino .3dm file import/export support
- ACIS .sat file import support
Moreover, NURBS-Python and its extensions are free and open-source projects distributed under the MIT license.
NURBS-Python is not an another NURBS library but it is mostly considered as one of its kind. Please see the Motivation page for more details.
Why two packages on PyPI?¶
Prior to NURBS-Python v4.0.0, the PyPI project name was NURBS-Python. The latest version of this package is v3.9.0 which is an alias for the geomdl package. To get the latest features and bug fixes, please use geomdl package and update whenever a new version is released. The simplest way to check if you are using the latest version is
$ pip list --outdated
Minimum Requirements¶
NURBS-Python (geomdl) is tested with Python versions 2.7.x, 3.4.x and higher.
Help and Support¶
Please join the email list on Google Groups. It is open for NURBS-Python users to ask questions, request new features and submit any other comments you may have.
Alternatively, you may send an email to nurbs-python@googlegroups.com.
How can I add a new feature?¶
The library is designed to be extensible in mind. It provides a set of abstract classes
for creating new geometry types. All classes use evaluators which contain the evaluation
algorithms. Evaluator classes can be extended for new type of algorithms. Please refer to BSpline and NURBS
modules for implementation examples. It would be also a good idea to refer to the constructors of the abstract
classes for more details.
Why doesn’t NURBS-Python have XYZ feature?¶
NURBS-Python tries to keep the geometric operations on the parametric space without any conversion to other representations. This approach makes some operations and queries hard to implement. Keeping NURBS-Python independent of libraries that require compilation caused including implementations some well-known geometric queries and computations, as well as a simple linear algebra module. However, the main purpose is providing a base for NURBS data and fundamental operations while keeping the external dependencies at minimum. It is users’ choice to extend the library and add new more advanced features (e.g. intersection computations) or capabilities (e.g. a new file format import/export support).
All advanced features should be packaged separately. If you are developing a feature to replace an existing feature, it might be a good idea to package it separately.
NURBS-Python may seem to keep very high standards by means of accepting contributions. For instance, if you implement a feature applicable to curves but not surfaces and volumes, such a pull request won’t be accepted till you add that feature to surfaces and volumes. Similarly, if you change a single module and/or the function you use most frequently, but that change is affecting the library as a whole, your pull request will be put on hold.
If you are not interested in such level of contributions, it is suggested to create a separate module and add geomdl
as its dependency. If you create a module which uses geomdl, please let the developers know via emailing
nurbs-python@googlegroups.com and you may be credited as a contributor.
Documentation references to the text books¶
NURBS-Python contains implementations of several algorithms and equations from the references stated in the Introduction section. Please be aware that there is always a difference between an algorithm and an implementation. Depending on the function/method documentation you are looking, it might be an implementation of an algorithm, an equation, a set of equations or the concept/the idea discussed in the given page range.
Why doesn’t NURBS-Python follow the algorithms?¶
Actually, NURBS-Python does follow the algorithms pretty much all the time. However, as stated above, the implementation that you are looking at might not belong to an algorithm, but an equation or a concept.