Metadata-Version: 2.2
Name: pydqm
Version: 0.1.2
Summary: Dynamic Quantum Mapping
Keywords: dimensionality reduction,visualization,animation,data science
Author-Email: Zander Teller <zander.teller@gmail.com>
License: MIT License
         
         Copyright (c) 2023 Zander Teller
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: C++
Classifier: Topic :: Scientific/Engineering
Project-URL: Homepage, https://github.com/zanderteller/dqm
Project-URL: Documentation, https://dqm.readthedocs.io
Project-URL: Repository, https://github.com/zanderteller/dqm
Project-URL: Issues, https://github.com/zanderteller/dqm/issues
Project-URL: Changelog, https://github.com/zanderteller/dqm/releases
Requires-Python: >=3.10
Requires-Dist: numpy
Provides-Extra: viz
Requires-Dist: jupyterlab; extra == "viz"
Requires-Dist: plotly; extra == "viz"
Requires-Dist: matplotlib; extra == "viz"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Description-Content-Type: text/x-rst

Dynamic Quantum Mapping (DQM)
=============================

Dynamic Quantum Mapping (DQM) is a unique, open-source system designed for exploring and understanding the intrinsic structure of high-dimensional numerical data.

DQM works on any given data set, using the mathematical framework of quantum mechanics, by creating a high-dimensional data-density map and then moving data points toward nearby regions of higher data density.

No assumptions are made about the underlying structure of the data.

Visual and numerical analysis of the resulting animated 'evolution' of the data can reveal both clusters and extended structures, leading to a rich understanding of relationships between and within different subsets of the data.

Installation
------------

Install DQM using pip:

.. code-block:: console

   $ pip install pydqm

For visualization support (recommended):

.. code-block:: console

   $ pip install pydqm[viz]

See the `Installation Guide <https://dqm.readthedocs.io/en/latest/installation.html>`_ for more details.

Documentation (on Read the Docs)
--------------------------------

`Documentation Homepage <https://dqm.readthedocs.io/en/latest>`_

* `Installation <https://dqm.readthedocs.io/en/latest/installation.html>`_
* `Quick Start <https://dqm.readthedocs.io/en/latest/quick_start.html>`_
* `User Guide <https://dqm.readthedocs.io/en/latest/user_guide.html>`_
* `API Reference <https://dqm.readthedocs.io/en/latest/api.html>`_
* `Frequently Asked Questions <https://dqm.readthedocs.io/en/latest/faq.html>`_
* `Links <https://dqm.readthedocs.io/en/latest/links.html>`_

Getting Involved
----------------

* Review the `contributing guidelines <./CONTRIBUTING.md>`_
* Open or review a `pull request <https://github.com/zanderteller/dqm/pulls>`_ (for contributions and changes to the project)
* Open or discuss an `issue <https://github.com/zanderteller/dqm/issues>`_ (for bug reports and feature requests)
* Create or join a `discussion <https://github.com/zanderteller/dqm/discussions>`_ (for anything other than issues)

Credits
-------

* Marvin Weinstein
* David Horn
* Bernard Chen
* Zander Teller

DQM uses the `Eigen <https://eigen.tuxfamily.org>`_ library for linear-algebra subroutines.

License
-------

`MIT License <./LICENSE.txt>`_

More Information
----------------

For more information, contact Zander Teller directly at zander@zanderteller.net.

|
