Metadata-Version: 2.1
Name: numcu
Version: 2.1.0
Summary: Numerical CUDA-based Python library built on CuVec
Keywords: Python,C,C++,buffer,vector,array,CUDA,CPython,pybind11,extensions,API
Author-Email: Casper da Costa-Luis <casper.dcl@physics.org>
License: MPL-2.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: GPU
Classifier: Environment :: GPU :: NVIDIA CUDA
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Project-URL: documentation, https://amypad.github.io/NumCu
Project-URL: repository, https://github.com/AMYPAD/NumCu
Project-URL: changelog, https://github.com/AMYPAD/NumCu/releases
Requires-Python: >=3.7
Requires-Dist: importlib_resources; python_version < "3.9"
Requires-Dist: cuvec>=2.11.0
Requires-Dist: numpy
Provides-Extra: dev
Requires-Dist: pytest>=6; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-timeout; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Description-Content-Type: text/x-rst

NumCu
=====

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

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

.. contents:: Table of contents
   :backlinks: top
   :local:

Install
~~~~~~~

Requirements:

- Python 3.7 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

.. code:: sh

    pip install numcu

Usage
~~~~~

See `the usage documentation <https://amypad.github.io/NumCu/#usage>`_.

Contributing
~~~~~~~~~~~~

See `CONTRIBUTING.md <https://github.com/AMYPAD/NumCu/blob/main/CONTRIBUTING.md>`_.

Licence
~~~~~~~

|Licence| |DOI|

Copyright:

- `Casper O. da Costa-Luis <https://github.com/casperdcl>`_
- `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/actions/workflow/status/AMYPAD/NumCu/test.yml?branch=main&logo=GitHub
   :target: https://github.com/AMYPAD/NumCu/actions
.. |Downloads| image:: https://img.shields.io/pypi/dm/numcu.svg?logo=pypi&logoColor=white&label=PyPI%20downloads
   :target: https://pypi.org/project/numcu
.. |Coverage| image:: https://codecov.io/gh/AMYPAD/NumCu/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/AMYPAD/NumCu
.. |Version| image:: https://img.shields.io/pypi/v/numcu.svg?logo=python&logoColor=white
   :target: https://github.com/AMYPAD/NumCu/releases
.. |Py-Versions| image:: https://img.shields.io/pypi/pyversions/numcu.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/numcu
