File tree Expand file tree Collapse file tree 4 files changed +46
-27
lines changed Expand file tree Collapse file tree 4 files changed +46
-27
lines changed Original file line number Diff line number Diff line change @@ -46,6 +46,7 @@ This documentation is organized into a couple sections:
4646 :caption: Modules
4747
4848 modules
49+ modules_experimental
4950
5051
5152The NURBS-Python Library is developed by `Onur Rauf Bingol <https://github.com/orbingol >`_ and all the code released
Original file line number Diff line number Diff line change 1+ Compatibility Module
2+ ^^^^^^^^^^^^^^^^^^^^
3+
4+ This module contains conversion operations related to control points, such as flipping arrays and adding weights.
5+
6+ .. automodule :: geomdl.compatibility
7+ :members:
Original file line number Diff line number Diff line change @@ -14,33 +14,7 @@ Following modules are included in this library:
1414 module_bspline
1515 module_nurbs
1616 module_utilities
17+ module_compatibility
1718 module_cpgen
1819 module_container
1920 module_exchange
20-
21- Visualization Module
22- ^^^^^^^^^^^^^^^^^^^^
23-
24- NURBS-Python provides an abstract base for visualization described under :doc: `Abstract <module_abstract >` class
25- reference. In addition, NURBS-Python comes with a sample module that uses `Matplotlib <https://matplotlib.org/ >`_.
26-
27- .. toctree ::
28- :maxdepth: 1
29-
30- module_vis_mpl
31-
32- Although there exists a visualization module, the users are completely free to use any visualization method
33- or visualization software. For instance, CSV exporting facility of the curve and surface classes can be used to plot
34- control points, curves and surfaces using a software, such as Paraview _.
35-
36- Generating Common Shapes
37- ^^^^^^^^^^^^^^^^^^^^^^^^
38-
39- NURBS-Python also provides a custom module for automatic generation of the most commonly used curves and surfaces.
40-
41- .. toctree ::
42- :maxdepth: 2
43-
44- module_shapes
45-
46- .. _Paraview : https://www.paraview.org/
Original file line number Diff line number Diff line change 1+ Experimental Modules
2+ ^^^^^^^^^^^^^^^^^^^^
3+
4+ NURBS-Python comes with several optional modules. These modules might require installation of additional packages,
5+ might come with extra requirements or their API might change between NURBS-Python releases. Therefore, even though
6+ they are distributed with the package, due to these reasons they are considered as experimental. However, they are
7+ mature enough to be used in production environments.
8+
9+ Visualization Module
10+ ^^^^^^^^^^^^^^^^^^^^
11+
12+ NURBS-Python provides an abstract base for visualization modules described under :doc: `Abstract <module_abstract >`
13+ class reference. This abstract base is a part of the :doc: `Core Library <modules >` and it is considered as mature now.
14+
15+ In addition, NURBS-Python comes with a sample experimental visualization module which implements the core abstract base.
16+ This experimental module uses several features of `Matplotlib <https://matplotlib.org/ >`_ as its visualization backend.
17+
18+ .. toctree ::
19+ :maxdepth: 1
20+
21+ module_vis_mpl
22+
23+ Although there exists a visualization module, the users are completely free to use any visualization method
24+ or visualization software. For instance, CSV exporting facility of the curve and surface classes can be used to plot
25+ control points, curves and surfaces using a software, such as Paraview _.
26+
27+ Generating Common Shapes
28+ ^^^^^^^^^^^^^^^^^^^^^^^^
29+
30+ NURBS-Python provides an experimental module for automatic generation of the most commonly used curves and surfaces.
31+
32+ .. toctree ::
33+ :maxdepth: 2
34+
35+ module_shapes
36+
37+ .. _Paraview : https://www.paraview.org/
You can’t perform that action at this time.
0 commit comments