Skip to content
This repository was archived by the owner on Dec 8, 2024. It is now read-only.

Commit 370ea56

Browse files
authored
Updated Badges and docs
* Added badges and CNAME file * Updated badges * Updated CM doc slightly
1 parent 8874e60 commit 370ea56

File tree

5 files changed

+16
-4
lines changed

5 files changed

+16
-4
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# QML: A Python Toolkit for Quantum Machine Learning
2-
[![Build Status](https://travis-ci.org/qmlcode/qml.svg?branch=master)](https://travis-ci.org/qmlcode/qml)
2+
[![Build Status](https://travis-ci.org/qmlcode/qml.svg?branch=master)](https://travis-ci.org/qmlcode/qml) [![doi](https://badge.fury.io/py/qml.svg)](https://badge.fury.io/py/qml) [![doi](https://zenodo.org/badge/89045103.svg)](https://zenodo.org/badge/latestdoi/89045103)
33

44
QML is a Python2/3-compatible toolkit for representation learning of properties of molecules and solids.
55

docs/Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ help:
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2121
touch build/html/.nojekyll
22+
echo "www.qmlcode.org" > build/html/CNAME

docs/source/examples.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
xamples
1+
Examples
22
--------
33

44
Generating representations using the ``Compound`` class

docs/source/index.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
|Build Status| |Beta|
6+
|Build Status| |pypi| |doi| |Beta|
77

88
QML: A Python Toolkit for Quantum Machine Learning
99
==================================================
@@ -79,6 +79,12 @@ QML is freely available under the terms of the MIT license.
7979
.. |Build Status| image:: https://travis-ci.org/qmlcode/qml.svg?branch=master
8080
:target: https://travis-ci.org/qmlcode/qml
8181

82+
.. |doi| image:: https://zenodo.org/badge/89045103.svg
83+
:target: https://zenodo.org/badge/latestdoi/89045103
84+
8285
.. |Beta| image:: http://i.imgur.com/5fMAeek.jpg
8386
:width: 90 px
8487
:target: https://github.com/qmlcode/qml
88+
89+
.. |Pypi| image:: https://badge.fury.io/py/qml.svg
90+
:target: https://badge.fury.io/py/qml

qml/representations.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040

4141
def generate_coulomb_matrix(nuclear_charges, coordinates, size = 23, sorting = "row-norm"):
4242
""" Creates a Coulomb Matrix representation of a molecule.
43+
Sorting of the elements can either be done by ``sorting="row-norm"`` or ``sorting="unsorted"``.
4344
A matrix :math:`M` is constructed with elements
4445
4546
.. math::
@@ -52,12 +53,16 @@ def generate_coulomb_matrix(nuclear_charges, coordinates, size = 23, sorting = "
5253
5354
where :math:`i` and :math:`j` are atom indices, :math:`Z` is nuclear charge and
5455
:math:`\\bf R` is the coordinate in euclidean space.
55-
if ``sorting = 'row-norm'``, the atom indices are reordered such that
56+
If ``sorting = 'row-norm'``, the atom indices are reordered such that
5657
5758
:math:`\\sum_j M_{1j}^2 \\geq \\sum_j M_{2j}^2 \\geq ... \\geq \\sum_j M_{nj}^2`
5859
5960
The upper triangular of M, including the diagonal, is concatenated to a 1D
6061
vector representation.
62+
63+
If ``sorting = 'unsorted``, the elements are sorted in the same order as the input coordinates
64+
and nuclear charges.
65+
6166
The representation is calculated using an OpenMP parallel Fortran routine.
6267
6368
:param nuclear_charges: Nuclear charges of the atoms in the molecule

0 commit comments

Comments
 (0)