Metadata-Version: 2.1
Name: numcu
Version: 0.0.0
Summary: Numerical CUDA-based Python library built on CuVec
Home-page: https://github.com/AMYPAD/NumCu
Author: Casper da Costa-Luis
Author-email: casper.dcl@physics.org
License: MPL 2.0
Project-URL: Changelog, https://github.com/AMYPAD/NumCu/releases
Project-URL: Documentation, https://amypad.github.io/NumCu
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: GPU
Classifier: Environment :: GPU :: NVIDIA CUDA
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.6
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 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: dev
License-File: LICENCE

NumCu
=====

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

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

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

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>`_)
- (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|

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>`__

.. |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
   :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


