Changed the python class names to be CamelCase

This is a python naming convention... Adapated the Tutorials accordingly.
liedllab · Feb 2, 2024 · d8af3d6 · d8af3d6
1 parent 51bafd3
commit d8af3d6
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/examples/XEntropy-example0-kde.ipynb b/examples/XEntropy-example0-kde.ipynb
@@ -62,7 +62,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "kernel = kde.kde(data=data,verbose=True)\n",
+    "kernel = kde.Kde(data=data,verbose=True)\n",
     "xs, ys = kernel.pdf_x,kernel.pdf"
    ]
   },
@@ -147,7 +147,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "kernel = kde.kde(data=data,verbose=True)\n",
+    "kernel = kde.Kde(data=data,verbose=True)\n",
     "xs, ys = kernel.pdf_x,kernel.pdf"
    ]
   },
@@ -222,7 +222,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "kernel = kde.kde(data=data,weights=weights,verbose=True)\n",
+    "kernel = kde.Kde(data=data,weights=weights,verbose=True)\n",
     "\n",
     "kernel.has_weights"
    ]
@@ -302,7 +302,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -316,7 +316,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.3"
+   "version": "3.9.7"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/examples/XEntropy-example1-dihedral_entropy.ipynb b/examples/XEntropy-example1-dihedral_entropy.ipynb
@@ -64,7 +64,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dih_ent = dihedrals.dihedralEntropy(data=data,verbose=True)\n",
+    "dih_ent = dihedrals.DihedralEntropy(data=data,verbose=True)\n",
     "dih_ent.calculate()"
    ]
   },
@@ -141,7 +141,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dih_ent = dihedrals.dihedralEntropy(data=data,verbose=True,input_unit=\"degree\")\n",
+    "dih_ent = dihedrals.DihedralEntropy(data=data,verbose=True,input_unit=\"degree\")\n",
     "\n",
     "dih_ent.calculate()"
    ]
@@ -225,7 +225,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dih_ent = dihedrals.dihedralEntropy(data=data, verbose=False, input_unit=\"degree\")\n",
+    "dih_ent = dihedrals.DihedralEntropy(data=data, verbose=False, input_unit=\"degree\")\n",
     "\n",
     "dih_ent.calculate()"
    ]
@@ -309,7 +309,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dih_ent = dihedrals.dihedralEntropy(data=data, verbose=False, input_unit=\"degree\")\n",
+    "dih_ent = dihedrals.DihedralEntropy(data=data, verbose=False, input_unit=\"degree\")\n",
     "\n",
     "dih_ent.calculate()"
    ]
@@ -406,7 +406,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dih_ent = dihedrals.dihedralEntropy(data=data, verbose=False, input_unit=\"degree\")\n",
+    "dih_ent = dihedrals.DihedralEntropy(data=data, verbose=False, input_unit=\"degree\")\n",
     "\n",
     "dih_ent.calculate()"
    ]
@@ -453,7 +453,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -467,7 +467,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.5"
+   "version": "3.9.7"
   },
   "toc": {
    "base_numbering": 1,

diff --git a/package/xentropy/dihedrals.py b/package/xentropy/dihedrals.py
@@ -17,7 +17,7 @@
 import warnings
 
 
-class dihedralEntropy(object):
+class DihedralEntropy(object):
 
     def __init__(self, data, weights=None, resolution="auto", verbose=False, method="Simpson", input_unit="auto"):
         # flags and output

diff --git a/package/xentropy/kde.py b/package/xentropy/kde.py
@@ -16,7 +16,7 @@ def check_dims(data):
                   "data: {}".format(data.shape)
         raise ValueError(err_msg)
 
-class kde(object):
+class Kde(object):
 
     def __init__(self, data, weights=None, resolution="auto", verbose=False):
         # to be set after calculation