qmllib


Nameqmllib JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryPython/Fortran toolkit for representation of molecules and solids for machine learning of properties of molecules and solids.
upload_time2024-03-29 20:19:01
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords qml quantum chemistry machine learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ====
What
====

``qmllib`` is a Python/Fortran toolkit for representation of molecules and solids
for machine learning of properties of molecules and solids. The library is not
a high-level framework where you can do ``model.train()``, but supplies the
building blocks to carry out efficient and accurate machine learning. As such,
the goal is to provide usable and efficient implementations of concepts such as
representations and kernels.

==============
QML or QMLLib?
==============

``qmllib`` represents the core library functionality derived from the original
QML package, providing a powerful toolkit for quantum machine learning
applications, but without the high-level abstraction, for example SKLearn.

This package is and should stay free-function design oriented.

Breaking changes from ``qml``:

* FCHL representations callable interface to be consistent with other representations (e.i. atoms, coordinates)


==============
How to install
==============

A proper pip-package is on the way, for now

.. code-block:: bash

    pip install git+https://github.com/qmlcode/qmllib

or if you want a specific feature branch

.. code-block:: bash

    pip install git+https://github.com/qmlcode/qmllib@feature_branch

=================
How to contribute
=================

Know a issue and want to get started developing?

.. code-block:: bash

    git clone repo.url qmllib.git
    cd qmllib.git
    make # setup env
    make compile # compile

You know have a conda environment in `./env` and are ready to run

.. code-block:: bash

    make test

happy developing

==========
How to use
==========

.. code-block:: python

    raise NotImplementedError

===========
How to cite
===========

.. code-block:: python

    raise NotImplementedError

=========
What TODO
=========

* Setup ifort flags
* Setup based on FCC env variable or --global-option flags
* Find MKL from env (for example conda)
* Find what numpy has been linked too (lapack or mkl)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "qmllib",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "qml, quantum chemistry, machine learning",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/18/ed/56af0c5a0596c543f6504b825135b9c83d532bf845cacd9702486101c50a/qmllib-1.0.1.tar.gz",
    "platform": null,
    "description": "====\nWhat\n====\n\n``qmllib`` is a Python/Fortran toolkit for representation of molecules and solids\nfor machine learning of properties of molecules and solids. The library is not\na high-level framework where you can do ``model.train()``, but supplies the\nbuilding blocks to carry out efficient and accurate machine learning. As such,\nthe goal is to provide usable and efficient implementations of concepts such as\nrepresentations and kernels.\n\n==============\nQML or QMLLib?\n==============\n\n``qmllib`` represents the core library functionality derived from the original\nQML package, providing a powerful toolkit for quantum machine learning\napplications, but without the high-level abstraction, for example SKLearn.\n\nThis package is and should stay free-function design oriented.\n\nBreaking changes from ``qml``:\n\n* FCHL representations callable interface to be consistent with other representations (e.i. atoms, coordinates)\n\n\n==============\nHow to install\n==============\n\nA proper pip-package is on the way, for now\n\n.. code-block:: bash\n\n    pip install git+https://github.com/qmlcode/qmllib\n\nor if you want a specific feature branch\n\n.. code-block:: bash\n\n    pip install git+https://github.com/qmlcode/qmllib@feature_branch\n\n=================\nHow to contribute\n=================\n\nKnow a issue and want to get started developing?\n\n.. code-block:: bash\n\n    git clone repo.url qmllib.git\n    cd qmllib.git\n    make # setup env\n    make compile # compile\n\nYou know have a conda environment in `./env` and are ready to run\n\n.. code-block:: bash\n\n    make test\n\nhappy developing\n\n==========\nHow to use\n==========\n\n.. code-block:: python\n\n    raise NotImplementedError\n\n===========\nHow to cite\n===========\n\n.. code-block:: python\n\n    raise NotImplementedError\n\n=========\nWhat TODO\n=========\n\n* Setup ifort flags\n* Setup based on FCC env variable or --global-option flags\n* Find MKL from env (for example conda)\n* Find what numpy has been linked too (lapack or mkl)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python/Fortran toolkit for representation of molecules and solids for machine learning of properties of molecules and solids.",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://qmlcode.org"
    },
    "split_keywords": [
        "qml",
        " quantum chemistry",
        " machine learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "18ed56af0c5a0596c543f6504b825135b9c83d532bf845cacd9702486101c50a",
                "md5": "6eeab895a8ce95201b6fbb76f4174c87",
                "sha256": "bae311b7788d5c62e55aba21c845c8b38e748ee86906cf7d226188345e0fc3f9"
            },
            "downloads": -1,
            "filename": "qmllib-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6eeab895a8ce95201b6fbb76f4174c87",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 96887,
            "upload_time": "2024-03-29T20:19:01",
            "upload_time_iso_8601": "2024-03-29T20:19:01.511989Z",
            "url": "https://files.pythonhosted.org/packages/18/ed/56af0c5a0596c543f6504b825135b9c83d532bf845cacd9702486101c50a/qmllib-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-29 20:19:01",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "qmllib"
}
        
Elapsed time: 0.23443s