diff --git a/README.rst b/README.rst index cfbd9fb0..2d98d816 100644 --- a/README.rst +++ b/README.rst @@ -11,17 +11,34 @@ Introduction ============ NURBS-Python (geomdl) is an object-oriented B-Spline and NURBS surface and curve library for Python with -implementations of advanced computation algorithms in an extensible way. -It comes with on-the-fly shape visualization options, knot vector and surface grid generators, and more. +implementations of advanced computation algorithms in an extensible way. It comes with various features, such as +on-the-fly visualization options, knot vector and surface grid generators, tessellation, voxelization and more. NURBS-Python is a pure Python library, therefore there are no external C/C++ or FORTRAN dependencies or any compilation -steps during installation. It is tested with Python v2.7.x, Python v3.4.x and later. +steps during installation. A Cython-compiled option also is provided for better performance. Moreover, the core library +is self-contained; and therefore, it can be easily used with systems using embedded Python. -Citing ------- +NURBS-Python is tested with Python v2.7.x, Python v3.4.x and later. -The citation options (BiBTeX entry, DOI name and others) can be found on the -`Citing `_ section of the documentation. +Citing NURBS-Python +------------------- + +The following article outlines the design and features of NURBS-Python (geomdl). I would be glad if you would cite it +if you have used NURBS-Python (geomdl) in your research:: + + @article{bingol2019geomdl, + title={{NURBS-Python}: An open-source object-oriented {NURBS} modeling framework in {Python}}, + author={Bingol, Onur Rauf and Krishnamurthy, Adarsh}, + journal={{SoftwareX}}, + volume={9}, + pages={85--94}, + year={2019}, + publisher={Elsevier}, + doi={https://doi.org/10.1016/j.softx.2018.12.005} + } + +Please refer to the `Citing `_ section of the documentation +for more details. Examples, Documentation and Extras ---------------------------------- @@ -30,6 +47,7 @@ Examples, Documentation and Extras * **Documentation**: http://nurbs-python.readthedocs.io/ * **Wiki**: https://github.com/orbingol/NURBS-Python/wiki * **Command line application**: https://github.com/orbingol/geomdl-cli +* **rw3dm**: https://github.com/orbingol/rw3dm Using NURBS-Python (geomdl) =========================== @@ -37,15 +55,15 @@ Using NURBS-Python (geomdl) Installation and Testing ------------------------ -Please see the `Installation and Testing `_ section -of the documentation. +Please refer to the `Installation and Testing `_ section +of the documentation for details. Contributions and Issues ------------------------ -All contributions are welcome. For details, please see the +All contributions are welcome. For details, please refer to the `Issues and Reporting `_ section of the -documentation. +documentation for details. Author ====== diff --git a/docs/citing.rst b/docs/citing.rst index 6c94d61c..039c3ac2 100644 --- a/docs/citing.rst +++ b/docs/citing.rst @@ -3,24 +3,34 @@ Citing NURBS-Python |DOI|_ -BibTeX +Article +======= + +We have published an article outlining the design and features of NURBS-Python (geomdl) on an open-access Elsevier +journal `SoftwareX `_ in the January-June 2019 issue. + +Please refer to the following DOI link to access the article: https://doi.org/10.1016/j.softx.2018.12.005 + +BibTex ====== -:: +You can use the following BibTeX entry to cite the NURBS-Python paper:: - @misc{bingol2016geomdl, - author = {Onur Rauf Bingol}, - title = {{NURBS-Python}}, - year = 2016, - doi = {10.5281/zenodo.815010}, - url = {https://github.com/orbingol/NURBS-Python} + @article{bingol2019geomdl, + title={{NURBS-Python}: An open-source object-oriented {NURBS} modeling framework in {Python}}, + author={Bingol, Onur Rauf and Krishnamurthy, Adarsh}, + journal={{SoftwareX}}, + volume={9}, + pages={85--94}, + year={2019}, + publisher={Elsevier} } -License -======= +Licenses +======== -NURBS-Python is a free and open-source project released under the terms of the **MIT License**. -Please see the LICENSE_ file for details. +* NURBS-Python source code is released under the terms of the **MIT License**. Please refer to the LICENSE_ file for details. +* NURBS-Python documentation is released under the terms of `CC BY 4.0 `_. .. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.815010.svg