@@ -11,17 +11,34 @@ Introduction
11
11
============
12
12
13
13
NURBS-Python (geomdl) is an object-oriented B-Spline and NURBS surface and curve library for Python with
14
- implementations of advanced computation algorithms in an extensible way.
15
- It comes with on-the-fly shape visualization options, knot vector and surface grid generators, and more.
14
+ implementations of advanced computation algorithms in an extensible way. It comes with various features, such as
15
+ on-the-fly visualization options, knot vector and surface grid generators, tessellation, voxelization and more.
16
16
17
17
NURBS-Python is a pure Python library, therefore there are no external C/C++ or FORTRAN dependencies or any compilation
18
- steps during installation. It is tested with Python v2.7.x, Python v3.4.x and later.
18
+ steps during installation. A Cython-compiled option also is provided for better performance. Moreover, the core library
19
+ is self-contained; and therefore, it can be easily used with systems using embedded Python.
19
20
20
- Citing
21
- ------
21
+ NURBS-Python is tested with Python v2.7.x, Python v3.4.x and later.
22
22
23
- The citation options (BiBTeX entry, DOI name and others) can be found on the
24
- `Citing <http://nurbs-python.readthedocs.io/en/latest/citing.html >`_ section of the documentation.
23
+ Citing NURBS-Python
24
+ -------------------
25
+
26
+ The following article outlines the design and features of NURBS-Python (geomdl). I would be glad if you would cite it
27
+ if you have used NURBS-Python (geomdl) in your research::
28
+
29
+ @article{bingol2019geomdl,
30
+ title={{NURBS-Python}: An open-source object-oriented {NURBS} modeling framework in {Python}},
31
+ author={Bingol, Onur Rauf and Krishnamurthy, Adarsh},
32
+ journal={{SoftwareX}},
33
+ volume={9},
34
+ pages={85--94},
35
+ year={2019},
36
+ publisher={Elsevier},
37
+ doi={https://doi.org/10.1016/j.softx.2018.12.005}
38
+ }
39
+
40
+ Please refer to the `Citing <http://nurbs-python.readthedocs.io/en/latest/citing.html >`_ section of the documentation
41
+ for more details.
25
42
26
43
Examples, Documentation and Extras
27
44
----------------------------------
@@ -30,22 +47,23 @@ Examples, Documentation and Extras
30
47
* **Documentation **: http://nurbs-python.readthedocs.io/
31
48
* **Wiki **: https://github.com/orbingol/NURBS-Python/wiki
32
49
* **Command line application **: https://github.com/orbingol/geomdl-cli
50
+ * **rw3dm **: https://github.com/orbingol/rw3dm
33
51
34
52
Using NURBS-Python (geomdl)
35
53
===========================
36
54
37
55
Installation and Testing
38
56
------------------------
39
57
40
- Please see the `Installation and Testing <http://nurbs-python.readthedocs.io/en/latest/install.html >`_ section
41
- of the documentation.
58
+ Please refer to the `Installation and Testing <http://nurbs-python.readthedocs.io/en/latest/install.html >`_ section
59
+ of the documentation for details .
42
60
43
61
Contributions and Issues
44
62
------------------------
45
63
46
- All contributions are welcome. For details, please see the
64
+ All contributions are welcome. For details, please refer to the
47
65
`Issues and Reporting <http://nurbs-python.readthedocs.io/en/latest/q_a.html#issues-and-reporting >`_ section of the
48
- documentation.
66
+ documentation for details .
49
67
50
68
Author
51
69
======
0 commit comments