detkit


Namedetkit JSON
Version 0.11.9 PyPI version JSON
download
home_pagehttps://github.com/ameli/detkit
SummaryMatrix determinant toolkit
upload_time2025-02-24 10:46:39
maintainerNone
docs_urlNone
authorSiavash Ameli
requires_python>=3.8
licenseNone
keywords matrix-computations cholesky-decomposition logdet matrix-determinant singular-matrix gaussian-process
VCS
bugtrack_url
requirements numpy scipy matplotlib texplot pooch psutil zarr dask distributed tensorstore
Travis-CI No Travis.
coveralls test coverage
            ******
|logo|
******

``detKit`` is a Python package for computing determinant functions of matrices.

Links
=====

* `Documentation <https://ameli.github.io/detkit>`__
* `PyPI <https://pypi.org/project/detkit/>`__
* `Anaconda <https://anaconda.org/s-ameli/detkit>`__
* `Docker Hub <https://hub.docker.com/r/sameli/detkit>`__
* `Github <https://github.com/ameli/detkit>`__

Install
=======

Install with ``pip``
--------------------

|pypi|

::

    pip install detkit

Install with ``conda``
----------------------

|conda-version|

::

    conda install s-ameli::detkit

Docker Image
------------

|docker-pull| |deploy-docker|

::

    docker pull sameli/detkit

Supported Platforms
===================

Successful installation and tests performed on the following operating systems, architectures, and Python and `PyPy <https://www.pypy.org/>`__ versions:

.. |y| unicode:: U+2714
.. |n| unicode:: U+2716

+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Platform | Arch              | Python Version                        | PyPy Version :sup:`1` | Continuous      |
+          |                   +-------+-------+-------+-------+-------+-------+-------+-------+ Integration     +
|          |                   |  3.9  |  3.10 |  3.11 |  3.12 |  3.13 |  3.8  |  3.9  |  3.10 |                 |
+==========+===================+=======+=======+=======+=======+=======+=======+=======+=======+=================+
| Linux    | X86-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  | |build-linux|   |
+          +-------------------+-------+-------+-------+-------+-------+-------+-------+-------+                 +
|          | AARCH-64          |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |                 |
+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| macOS    | X86-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  | |build-macos|   |
+          +-------------------+-------+-------+-------+-------+-------+-------+-------+-------+                 +
|          | ARM-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |                 |
+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Windows  | X86-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  | |build-windows| |
+          +-------------------+-------+-------+-------+-------+-------+-------+-------+-------+                 +
|          | ARM-64 :sup:`2`   |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |                 |
+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+

.. |build-linux| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/build-linux.yml
   :target: https://github.com/ameli/detkit/actions?query=workflow%3Abuild-linux 
.. |build-macos| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/build-macos.yml
   :target: https://github.com/ameli/detkit/actions?query=workflow%3Abuild-macos
.. |build-windows| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/build-windows.yml
   :target: https://github.com/ameli/detkit/actions?query=workflow%3Abuild-windows

Python wheels for ``detkit`` for all supported platforms and versions in the above are available through `PyPI <https://pypi.org/project/detkit/>`__ and `Anaconda Cloud <https://anaconda.org/s-ameli/detkit>`__. If you need ``detkit`` on other platforms, architectures, and Python or PyPy versions, `raise an issue <https://github.com/ameli/detkit/issues>`__ on GitHub and we build its Python Wheel for you.

.. line-block::

    :sup:`1. Wheels for PyPy are exclusively available for installation through pip and cannot be installed using conda.`
    :sup:`2. Wheels for Windows on ARM-64 architecture are exclusively available for installation through pip and cannot be installed using conda.`

Documentation
=============

|deploy-docs| |binder|

See `documentation <https://ameli.github.io/detkit/index.html>`__ of the package.

Benchmark Test
==============

Read about the `benchmark test <https://ameli.github.io/detkit/benchmark.html>`__ of ``detkit`` in practical applications.

How to Contribute
=================

We welcome contributions via `GitHub's pull request <https://github.com/ameli/detkit/pulls>`__. If you do not feel comfortable modifying the code, we also welcome feature requests and bug reports as `GitHub issues <https://github.com/ameli/detkit/issues>`__.

How to Cite
===========

If you publish work that uses ``detkit``, please consider citing the manuscripts available `here <https://ameli.github.io/detkit/cite.html>`__.

License
=======

|license|

This project uses a `BSD 3-clause license <https://github.com/ameli/detkit/blob/main/LICENSE.txt>`__, in hopes that it will be accessible to most projects. If you require a different license, please raise an `issue <https://github.com/ameli/detkit/issues>`__ and we will consider a dual license.

.. |logo| image:: https://raw.githubusercontent.com/ameli/detkit/main/docs/source/_static/images/icons/logo-detkit-light.svg
   :width: 160
.. |license| image:: https://img.shields.io/github/license/ameli/detkit
   :target: https://opensource.org/licenses/BSD-3-Clause
.. |deploy-docs| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/deploy-docs.yml?label=docs
   :target: https://github.com/ameli/detkit/actions?query=workflow%3Adeploy-docs
.. |binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/ameli/detkit/HEAD?filepath=notebooks%2Fquick_start.ipynb
.. |pypi| image:: https://img.shields.io/pypi/v/detkit
   :target: https://pypi.org/project/detkit/
.. |deploy-docker| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/deploy-docker.yml?label=build%20docker
   :target: https://github.com/ameli/detkit/actions?query=workflow%3Adeploy-docker
.. |docker-pull| image:: https://img.shields.io/docker/pulls/sameli/detkit?color=green&label=downloads
   :target: https://hub.docker.com/r/sameli/detkit
.. |conda-version| image:: https://img.shields.io/conda/v/s-ameli/detkit
   :target: https://anaconda.org/s-ameli/detkit

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ameli/detkit",
    "name": "detkit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "matrix-computations cholesky-decomposition logdet\n                matrix-determinant singular-matrix gaussian-process",
    "author": "Siavash Ameli",
    "author_email": "sameli@berkeley.edu",
    "download_url": "https://github.com/ameli/detkit/archive/main.zip",
    "platform": "Linux",
    "description": "******\n|logo|\n******\n\n``detKit`` is a Python package for computing determinant functions of matrices.\n\nLinks\n=====\n\n* `Documentation <https://ameli.github.io/detkit>`__\n* `PyPI <https://pypi.org/project/detkit/>`__\n* `Anaconda <https://anaconda.org/s-ameli/detkit>`__\n* `Docker Hub <https://hub.docker.com/r/sameli/detkit>`__\n* `Github <https://github.com/ameli/detkit>`__\n\nInstall\n=======\n\nInstall with ``pip``\n--------------------\n\n|pypi|\n\n::\n\n    pip install detkit\n\nInstall with ``conda``\n----------------------\n\n|conda-version|\n\n::\n\n    conda install s-ameli::detkit\n\nDocker Image\n------------\n\n|docker-pull| |deploy-docker|\n\n::\n\n    docker pull sameli/detkit\n\nSupported Platforms\n===================\n\nSuccessful installation and tests performed on the following operating systems, architectures, and Python and `PyPy <https://www.pypy.org/>`__ versions:\n\n.. |y| unicode:: U+2714\n.. |n| unicode:: U+2716\n\n+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+\n| Platform | Arch              | Python Version                        | PyPy Version :sup:`1` | Continuous      |\n+          |                   +-------+-------+-------+-------+-------+-------+-------+-------+ Integration     +\n|          |                   |  3.9  |  3.10 |  3.11 |  3.12 |  3.13 |  3.8  |  3.9  |  3.10 |                 |\n+==========+===================+=======+=======+=======+=======+=======+=======+=======+=======+=================+\n| Linux    | X86-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  | |build-linux|   |\n+          +-------------------+-------+-------+-------+-------+-------+-------+-------+-------+                 +\n|          | AARCH-64          |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |                 |\n+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+\n| macOS    | X86-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  | |build-macos|   |\n+          +-------------------+-------+-------+-------+-------+-------+-------+-------+-------+                 +\n|          | ARM-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |                 |\n+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+\n| Windows  | X86-64            |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  | |build-windows| |\n+          +-------------------+-------+-------+-------+-------+-------+-------+-------+-------+                 +\n|          | ARM-64 :sup:`2`   |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |  |y|  |                 |\n+----------+-------------------+-------+-------+-------+-------+-------+-------+-------+-------+-----------------+\n\n.. |build-linux| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/build-linux.yml\n   :target: https://github.com/ameli/detkit/actions?query=workflow%3Abuild-linux \n.. |build-macos| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/build-macos.yml\n   :target: https://github.com/ameli/detkit/actions?query=workflow%3Abuild-macos\n.. |build-windows| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/build-windows.yml\n   :target: https://github.com/ameli/detkit/actions?query=workflow%3Abuild-windows\n\nPython wheels for ``detkit`` for all supported platforms and versions in the above are available through `PyPI <https://pypi.org/project/detkit/>`__ and `Anaconda Cloud <https://anaconda.org/s-ameli/detkit>`__. If you need ``detkit`` on other platforms, architectures, and Python or PyPy versions, `raise an issue <https://github.com/ameli/detkit/issues>`__ on GitHub and we build its Python Wheel for you.\n\n.. line-block::\n\n    :sup:`1. Wheels for PyPy are exclusively available for installation through pip and cannot be installed using conda.`\n    :sup:`2. Wheels for Windows on ARM-64 architecture are exclusively available for installation through pip and cannot be installed using conda.`\n\nDocumentation\n=============\n\n|deploy-docs| |binder|\n\nSee `documentation <https://ameli.github.io/detkit/index.html>`__ of the package.\n\nBenchmark Test\n==============\n\nRead about the `benchmark test <https://ameli.github.io/detkit/benchmark.html>`__ of ``detkit`` in practical applications.\n\nHow to Contribute\n=================\n\nWe welcome contributions via `GitHub's pull request <https://github.com/ameli/detkit/pulls>`__. If you do not feel comfortable modifying the code, we also welcome feature requests and bug reports as `GitHub issues <https://github.com/ameli/detkit/issues>`__.\n\nHow to Cite\n===========\n\nIf you publish work that uses ``detkit``, please consider citing the manuscripts available `here <https://ameli.github.io/detkit/cite.html>`__.\n\nLicense\n=======\n\n|license|\n\nThis project uses a `BSD 3-clause license <https://github.com/ameli/detkit/blob/main/LICENSE.txt>`__, in hopes that it will be accessible to most projects. If you require a different license, please raise an `issue <https://github.com/ameli/detkit/issues>`__ and we will consider a dual license.\n\n.. |logo| image:: https://raw.githubusercontent.com/ameli/detkit/main/docs/source/_static/images/icons/logo-detkit-light.svg\n   :width: 160\n.. |license| image:: https://img.shields.io/github/license/ameli/detkit\n   :target: https://opensource.org/licenses/BSD-3-Clause\n.. |deploy-docs| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/deploy-docs.yml?label=docs\n   :target: https://github.com/ameli/detkit/actions?query=workflow%3Adeploy-docs\n.. |binder| image:: https://mybinder.org/badge_logo.svg\n   :target: https://mybinder.org/v2/gh/ameli/detkit/HEAD?filepath=notebooks%2Fquick_start.ipynb\n.. |pypi| image:: https://img.shields.io/pypi/v/detkit\n   :target: https://pypi.org/project/detkit/\n.. |deploy-docker| image:: https://img.shields.io/github/actions/workflow/status/ameli/detkit/deploy-docker.yml?label=build%20docker\n   :target: https://github.com/ameli/detkit/actions?query=workflow%3Adeploy-docker\n.. |docker-pull| image:: https://img.shields.io/docker/pulls/sameli/detkit?color=green&label=downloads\n   :target: https://hub.docker.com/r/sameli/detkit\n.. |conda-version| image:: https://img.shields.io/conda/v/s-ameli/detkit\n   :target: https://anaconda.org/s-ameli/detkit\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Matrix determinant toolkit",
    "version": "0.11.9",
    "project_urls": {
        "Documentation": "https://github.com/ameli/detkit/blob/main/README.rst",
        "Download": "https://github.com/ameli/detkit/archive/main.zip",
        "Homepage": "https://github.com/ameli/detkit",
        "Source": "https://github.com/ameli/detkit",
        "Tracker": "https://github.com/ameli/detkit/issues"
    },
    "split_keywords": [
        "matrix-computations",
        "cholesky-decomposition",
        "logdet\n",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "matrix-determinant",
        "singular-matrix",
        "gaussian-process"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "63a82138e44a8d4e6249f49760d36751a07a8672b15e010bb20b4de7eca31d5e",
                "md5": "035b398d71026b160f6e1d0578e3c35a",
                "sha256": "a6d0edc2c0cc31b3452e7e31bf9523c5bba89012321fc67feb02dfa0b2d21047"
            },
            "downloads": -1,
            "filename": "detkit-0.11.9-cp310-cp310-macosx_10_9_x86_64.whl",
            "has_sig": false,
            "md5_digest": "035b398d71026b160f6e1d0578e3c35a",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": ">=3.8",
            "size": 1842375,
            "upload_time": "2025-02-24T10:46:39",
            "upload_time_iso_8601": "2025-02-24T10:46:39.787298Z",
            "url": "https://files.pythonhosted.org/packages/63/a8/2138e44a8d4e6249f49760d36751a07a8672b15e010bb20b4de7eca31d5e/detkit-0.11.9-cp310-cp310-macosx_10_9_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-24 10:46:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ameli",
    "github_project": "detkit",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    ">",
                    "1.11"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    ">=",
                    "1.5"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "2.0"
                ]
            ]
        },
        {
            "name": "texplot",
            "specs": []
        },
        {
            "name": "pooch",
            "specs": []
        },
        {
            "name": "psutil",
            "specs": []
        },
        {
            "name": "zarr",
            "specs": []
        },
        {
            "name": "dask",
            "specs": []
        },
        {
            "name": "distributed",
            "specs": []
        },
        {
            "name": "tensorstore",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "detkit"
}
        
Elapsed time: 0.49001s