Skip to content

Commit

Permalink
[skip ci] Update citing
Browse files Browse the repository at this point in the history
  • Loading branch information
Onur Rauf Bingol committed Jan 18, 2019
1 parent 464b334 commit a60481b
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 23 deletions.
40 changes: 29 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <http://nurbs-python.readthedocs.io/en/latest/citing.html>`_ 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 <http://nurbs-python.readthedocs.io/en/latest/citing.html>`_ section of the documentation
for more details.

Examples, Documentation and Extras
----------------------------------
Expand All @@ -30,22 +47,23 @@ 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)
===========================

Installation and Testing
------------------------

Please see the `Installation and Testing <http://nurbs-python.readthedocs.io/en/latest/install.html>`_ section
of the documentation.
Please refer to the `Installation and Testing <http://nurbs-python.readthedocs.io/en/latest/install.html>`_ 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 <http://nurbs-python.readthedocs.io/en/latest/q_a.html#issues-and-reporting>`_ section of the
documentation.
documentation for details.

Author
======
Expand Down
34 changes: 22 additions & 12 deletions docs/citing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.sciencedirect.com/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 <https://creativecommons.org/licenses/by/4.0/>`_.


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

0 comments on commit a60481b

Please sign in to comment.