From cead86eeef0fa158030501b993d79cfc2448f33b Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Sun, 21 Aug 2022 17:34:00 +0100 Subject: [PATCH] docs: add DOI --- README.rst | 8 +++++--- docs/index.md | 5 +++-- docs/licence.md | 2 ++ docs/pydoc-markdown.yml | 2 ++ 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 3f35eb0..0f4ec18 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ NumCu Numerical CUDA-based Python library built on top of `CuVec `_. -|Version| |Downloads| |Py-Versions| |Licence| |Tests| |Coverage| +|Version| |Downloads| |Py-Versions| |DOI| |Licence| |Tests| |Coverage| .. contents:: Table of contents :backlinks: top @@ -14,7 +14,7 @@ Install Requirements: -- Python 3.6 or greater (e.g. via `Anaconda or Miniconda `_) +- Python 3.6 or greater (e.g. via `Anaconda or Miniconda `_ or via `python3-dev`) - (optional) `CUDA SDK/Toolkit `_ (including drivers for an NVIDIA GPU) * note that if the CUDA SDK/Toolkit is installed *after* NumCu, then NumCu must be re-installed to enable CUDA support @@ -36,13 +36,15 @@ See `CONTRIBUTING.md Licence ~~~~~~~ -|Licence| +|Licence| |DOI| Copyright 2022 - `Casper O. da Costa-Luis `__ @ University College London/King's College London - `Contributors `__ +.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7013340.svg + :target: https://doi.org/10.5281/zenodo.7013340 .. |Licence| image:: https://img.shields.io/pypi/l/numcu.svg?label=licence :target: https://github.com/AMYPAD/NumCu/blob/main/LICENCE .. |Tests| image:: https://img.shields.io/github/workflow/status/AMYPAD/NumCu/Test?logo=GitHub diff --git a/docs/index.md b/docs/index.md index e5fab5c..ce75ebf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,9 +2,10 @@ Numerical CUDA-based Python library built on top of [CuVec](https://amypad.github.com/CuVec). -[![Version](https://img.shields.io/pypi/v/o.svg?logo=python&logoColor=white)](https://github.com/AMYPAD/NumCu/releases) +[![Version](https://img.shields.io/pypi/v/numcu.svg?logo=python&logoColor=white)](https://github.com/AMYPAD/NumCu/releases) [![Downloads](https://img.shields.io/pypi/dm/numcu.svg?logo=pypi&logoColor=white&label=PyPI%20downloads)](https://pypi.org/project/numcu) [![Py-Versions](https://img.shields.io/pypi/pyversions/numcu.svg?logo=python&logoColor=white)](https://pypi.org/project/numcu) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7013340.svg)](https://doi.org/10.5281/zenodo.7013340) [![Licence](https://img.shields.io/pypi/l/numcu.svg?label=licence)](https://github.com/AMYPAD/NumCu/blob/main/LICENCE) [![Tests](https://img.shields.io/github/workflow/status/AMYPAD/NumCu/Test?logo=GitHub)](https://github.com/AMYPAD/NumCu/actions) [![Coverage](https://codecov.io/gh/AMYPAD/NumCu/branch/main/graph/badge.svg)](https://codecov.io/gh/AMYPAD/NumCu) @@ -17,7 +18,7 @@ pip install numcu Requirements: -- Python 3.6 or greater (e.g. via [Anaconda or Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html#anaconda-or-miniconda)) +- Python 3.6 or greater (e.g. via [Anaconda or Miniconda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/download.html#anaconda-or-miniconda) or via `python3-dev`) - (optional) [CUDA SDK/Toolkit](https://developer.nvidia.com/cuda-downloads) (including drivers for an NVIDIA GPU) + note that if the CUDA SDK/Toolkit is installed *after* NumCu, then NumCu must be re-installed to enable CUDA support diff --git a/docs/licence.md b/docs/licence.md index ad4666d..36dfbcb 100644 --- a/docs/licence.md +++ b/docs/licence.md @@ -1,5 +1,7 @@ Copyright © [Casper da Costa-Luis](https://github.com/casperdcl) 2022 +Citation: [DOI:10.5281/zenodo.7013340](https://doi.org/10.5281/zenodo.7013340) + > Exhibit A - Source Code Form License Notice > ------------------------------------------- > diff --git a/docs/pydoc-markdown.yml b/docs/pydoc-markdown.yml index 5f2a246..12d98e5 100644 --- a/docs/pydoc-markdown.yml +++ b/docs/pydoc-markdown.yml @@ -31,6 +31,8 @@ renderer: href: https://github.com/AMYPAD/NumCu/releases - title: Issues href: https://github.com/AMYPAD/NumCu/issues?q= + - title: Citation/DOI + href: https://doi.org/10.5281/zenodo.7013340 - title: Contributing name: contrib source: ../CONTRIBUTING.md