Metadata-Version: 2.1
Name: numkit
Version: 1.2.2
Summary: numerical first aid kit
Home-page: https://github.com/Becksteinlab/numkit
Author: Oliver Beckstein
Author-email: orbeckst@gmail.com
License: BSD
Project-URL: Documentation, https://numkit.readthedocs.org/
Project-URL: Issue Tracker, https://github.com/Becksteinlab/numkit/issues
Project-URL: Source, https://github.com/Becksteinlab/numkit
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows 
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
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: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.9)
Requires-Dist: scipy (>=1.0)
Requires-Dist: six

======
numkit
======

|docs| |build| |cov|

**numkit** is a small collection of numerical helper functions and
classes ("numerical first aid kit") that have been useful for
GromacsWrapper_ and related projects.

Originally, **numkit** was part of GromacsWrapper_ but was split off
into its own small package in version 0.7.0 of GromacsWrapper.

.. _GromacsWrapper: https://gromacswrapper.readthedocs.org/


Getting numkit
==============

Install with ``pip`` from PyPi with ::

    pip install numkit

or with ``conda`` from the *bioconda* channel ::

   conda install -c conda-forge -c bioconda numkit

The source code is available under the BSD 3-clause license (see file
LICENSE) from GitHub in the repository
https://github.com/Becksteinlab/numkit ::

  git clone https://github.com/Becksteinlab/numkit

Python 2/3
==========

Python 2.7 is still supported. Python 3 support for releases 3.6 - 3.9
is tested.


Contributing
============

Contributions are very welcome in all forms, especially through issue
reports and pull requests.


.. |build| image:: https://github.com/Becksteinlab/numkit/actions/workflows/ci.yaml/badge.svg?branch=master
   :alt: Build status
   :target: https://github.com/Becksteinlab/numkit/actions/workflows/ci.yaml
   :scale: 100%

.. |docs| image:: https://readthedocs.org/projects/numkit/badge/?version=latest
   :target: https://numkit.readthedocs.org/en/latest/?badge=latest
   :alt: Documentation
   :scale: 100%

.. |cov| image:: https://codecov.io/gh/Becksteinlab/numkit/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/Becksteinlab/numkit?branch=master
   :alt: Code Coverage
   :scale: 100%



