|
1 | 1 | NURBS-Python |
2 | 2 | ^^^^^^^^^^^^ |
3 | 3 |
|
4 | | -|DOI|_ |RTD|_ |TRAVISCI|_ |APPVEYOR|_ |WAFFLEIO|_ |
5 | | - |
6 | | - |
7 | | -.. note:: |
8 | | - |
9 | | - Starting from v4.0, this package will be renamed to `geomdl <https://pypi.org/project/geomdl/>`_. |
10 | | - Please see the `documentation <http://nurbs-python.readthedocs.io/en/latest/install.html>`_ for more details. |
11 | | - |
12 | | - |
13 | | -Description |
14 | | -=========== |
15 | | - |
16 | | -NURBS-Python provides Non-Uniform Rational B-Spline (NURBS) surface and 2D/3D curve data structures and computation |
17 | | -algorithms in native Python. The library is fully object-oriented and does *not* depend on any external libraries. |
18 | | - |
19 | | -Features |
20 | | -======== |
21 | | - |
22 | | -NURBS-Python consists of the following modules and components: |
23 | | - |
24 | | -* Core library |
25 | | -* Multi module |
26 | | -* Exchange module |
27 | | -* Visualization component |
28 | | -* Shapes component |
29 | | - |
30 | | -Core Library |
31 | | ------------- |
32 | | - |
33 | | -The core library contains 4 modules: |
34 | | - |
35 | | -* ``geomdl.BSpline`` contains Non-Uniform B-Spline (NUBS) evaluation and storage functionality |
36 | | -* ``geomdl.NURBS`` contains Non-Uniform Rational B-Spline (NURBS) evaluation and storage functionality |
37 | | -* ``geomdl.CPGen`` contains simple control points grid generation algorithms |
38 | | -* ``geomdl.utilities`` contains helper functions for generating and altering knot vectors and control points |
39 | | - |
40 | | -``geomdl.BSpline`` and ``geomdl.NURBS`` modules contain the following classes: |
41 | | - |
42 | | -* **Curve** for evaluating curves (in any dimension) |
43 | | -* **Surface** for evaluating surfaces |
44 | | - |
45 | | -``geomdl.CPGen`` module contains 2 classes for grid generation: |
46 | | - |
47 | | -* **Grid** for generating inputs for ``geomdl.BSpline.Surface`` class |
48 | | -* **GridWeighted** for generating inputs for ``geomdl.NURBS.Surface`` class |
49 | | - |
50 | | -NURBS-Python provides abstract *Curve* and *Surface* base classes in ``geomdl.Abstract`` module. |
51 | | - |
52 | | -Multi Module |
53 | | ------------- |
54 | | - |
55 | | -NURBS-Python provides container-like classes for working with multiple curves and surfaces in ``geomdl.Multi`` module. |
56 | | -Please see the documentation for details. |
57 | | - |
58 | | -Exchange Module |
59 | | ---------------- |
60 | | - |
61 | | -NURBS-Python can export `Surface` types in OBJ and STL format using ``geomdl.exchange`` module. This module contains 2 |
62 | | -major functions: |
63 | | - |
64 | | -* ``save_obj`` for saving surfaces as .obj files |
65 | | -* ``save_stl`` for saving surfaces as .stl files in ascii or binary format (default is binary) |
66 | | - |
67 | | -Visualization Component |
68 | | ------------------------ |
69 | | - |
70 | | -NURBS-Python comes with an experimental visualization module, ``geomdl.visualization``, for plotting generated |
71 | | -2D/3D curves and surfaces directly. |
72 | | - |
73 | | -Shapes Component |
74 | | ----------------- |
75 | | - |
76 | | -A new experimental module ``geomdl.shapes`` is also shipped with the NURBS-Python package. |
77 | | -The aim of this component is providing an easy way to generate the most common curves and surfaces, such as circles and |
78 | | -cylinders. |
79 | | - |
80 | | -Further Reading |
81 | | -=============== |
82 | | - |
83 | | -* Github repository: https://github.com/orbingol/NURBS-Python/tree/3.x |
84 | | -* Examples: https://github.com/orbingol/NURBS-Python_Examples/tree/3.x |
85 | | -* Documentation: https://nurbs-python.readthedocs.io/en/3.x/ |
86 | | - |
87 | | -License |
88 | | -======= |
89 | | - |
90 | | -NURBS-Python is licensed under The MIT License. |
91 | | - |
92 | | - |
93 | | -.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.815010.svg |
94 | | -.. _DOI: https://doi.org/10.5281/zenodo.815010 |
95 | | - |
96 | | -.. |RTD| image:: https://readthedocs.org/projects/nurbs-python/badge/?version=stable |
97 | | -.. _RTD: http://nurbs-python.readthedocs.io/en/stable/?badge=stable |
98 | | - |
99 | | -.. |WAFFLEIO| image:: https://badge.waffle.io/orbingol/NURBS-Python.svg?columns=all |
100 | | -.. _WAFFLEIO: https://waffle.io/orbingol/NURBS-Python |
101 | | - |
102 | | -.. |TRAVISCI| image:: https://travis-ci.org/orbingol/NURBS-Python.svg?branch=master |
103 | | -.. _TRAVISCI: https://travis-ci.org/orbingol/NURBS-Python |
104 | | - |
105 | | -.. |APPVEYOR| image:: https://ci.appveyor.com/api/projects/status/github/orbingol/nurbs-python?branch=master&svg=true |
106 | | -.. _APPVEYOR: https://ci.appveyor.com/project/orbingol/nurbs-python |
107 | | - |
108 | | -.. _NURBS-Python: https://github.com/orbingol/NURBS-Python |
109 | | -.. _Examples: https://github.com/orbingol/NURBS-Python_Examples |
| 4 | +Starting from v3.9.0, this package works as the alias for `geomdl <https://pypi.org/project/geomdl/>`_ package. |
| 5 | +**geomdl** is the next version of NURBS-Python with a number of improved features. |
| 6 | +You can also use **geomdl** with the command line tool `geomdl-cli <https://pypi.org/project/geomdl.cli/>`_. |
| 7 | +Please see the `documentation <https://nurbs-python.readthedocs.io/>`_ for more details. |
0 commit comments