Skip to content

Commit

Permalink
docs: add DOI
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Aug 21, 2022
1 parent 9004cad commit cead86e
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ NumCu

Numerical CUDA-based Python library built on top of `CuVec <https://github.com/AMYPAD/CuVec>`_.

|Version| |Downloads| |Py-Versions| |Licence| |Tests| |Coverage|
|Version| |Downloads| |Py-Versions| |DOI| |Licence| |Tests| |Coverage|

.. contents:: Table of contents
:backlinks: top
Expand All @@ -14,7 +14,7 @@ Install

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
Expand All @@ -36,13 +36,15 @@ See `CONTRIBUTING.md <https://github.com/AMYPAD/NumCu/blob/main/CONTRIBUTING.md>
Licence
~~~~~~~

|Licence|
|Licence| |DOI|

Copyright 2022

- `Casper O. da Costa-Luis <https://github.com/casperdcl>`__ @ University College London/King's College London
- `Contributors <https://github.com/AMYPAD/numcu/graphs/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
Expand Down
5 changes: 3 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
2 changes: 2 additions & 0 deletions docs/licence.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Copyright &copy; [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
> -------------------------------------------
>
Expand Down
2 changes: 2 additions & 0 deletions docs/pydoc-markdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cead86e

Please sign in to comment.