Skip to content

Commit a60481b

Browse files
author
Onur Rauf Bingol
committed
[skip ci] Update citing
1 parent 464b334 commit a60481b

File tree

2 files changed

+51
-23
lines changed

2 files changed

+51
-23
lines changed

README.rst

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,34 @@ Introduction
1111
============
1212

1313
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.
1616

1717
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.
1920

20-
Citing
21-
------
21+
NURBS-Python is tested with Python v2.7.x, Python v3.4.x and later.
2222

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.
2542

2643
Examples, Documentation and Extras
2744
----------------------------------
@@ -30,22 +47,23 @@ Examples, Documentation and Extras
3047
* **Documentation**: http://nurbs-python.readthedocs.io/
3148
* **Wiki**: https://github.com/orbingol/NURBS-Python/wiki
3249
* **Command line application**: https://github.com/orbingol/geomdl-cli
50+
* **rw3dm**: https://github.com/orbingol/rw3dm
3351

3452
Using NURBS-Python (geomdl)
3553
===========================
3654

3755
Installation and Testing
3856
------------------------
3957

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.
4260

4361
Contributions and Issues
4462
------------------------
4563

46-
All contributions are welcome. For details, please see the
64+
All contributions are welcome. For details, please refer to the
4765
`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.
4967

5068
Author
5169
======

docs/citing.rst

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,34 @@ Citing NURBS-Python
33

44
|DOI|_
55

6-
BibTeX
6+
Article
7+
=======
8+
9+
We have published an article outlining the design and features of NURBS-Python (geomdl) on an open-access Elsevier
10+
journal `SoftwareX <https://www.sciencedirect.com/journal/softwarex>`_ in the January-June 2019 issue.
11+
12+
Please refer to the following DOI link to access the article: https://doi.org/10.1016/j.softx.2018.12.005
13+
14+
BibTex
715
======
816

9-
::
17+
You can use the following BibTeX entry to cite the NURBS-Python paper::
1018

11-
@misc{bingol2016geomdl,
12-
author = {Onur Rauf Bingol},
13-
title = {{NURBS-Python}},
14-
year = 2016,
15-
doi = {10.5281/zenodo.815010},
16-
url = {https://github.com/orbingol/NURBS-Python}
19+
@article{bingol2019geomdl,
20+
title={{NURBS-Python}: An open-source object-oriented {NURBS} modeling framework in {Python}},
21+
author={Bingol, Onur Rauf and Krishnamurthy, Adarsh},
22+
journal={{SoftwareX}},
23+
volume={9},
24+
pages={85--94},
25+
year={2019},
26+
publisher={Elsevier}
1727
}
1828

19-
License
20-
=======
29+
Licenses
30+
========
2131

22-
NURBS-Python is a free and open-source project released under the terms of the **MIT License**.
23-
Please see the LICENSE_ file for details.
32+
* NURBS-Python source code is released under the terms of the **MIT License**. Please refer to the LICENSE_ file for details.
33+
* NURBS-Python documentation is released under the terms of `CC BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`_.
2434

2535

2636
.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.815010.svg

0 commit comments

Comments
 (0)