{ "info": { "author": "Stefan Chmiela", "author_email": "sgdml@chmiela.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: MacOS :: MacOS X", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering :: Chemistry", "Topic :: Scientific/Engineering :: Physics", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "# Symmetric Gradient Domain Machine Learning (sGDML)\n\nFor more details visit: [http://sgdml.org/](http://sgdml.org/)\n\nDocumentation can be found here: [http://sgdml.org/doc/](http://sgdml.org/doc/)\n\n#### Requirements:\n- Python 2.7/3.7\n- NumPy (>=1.13.0)\n- SciPy\n- PyTorch (optional)\n\n## Getting started\n\n### Stable release\n\nMost systems come with the default package manager for Python ``pip`` already preinstalled. Install ``sgdml`` by simply calling:\n\n`pip install sgdml`\n\nThe ``sgdml`` command-line interface and the corresponding Python API can now be used from anywhere on the system.\n\n### Development version\n\n#### (1) Clone the repository\n\n`git clone https://github.com/stefanch/sGDML.git`\n\n`cd sGDML`\n\n...or update your existing local copy with\n\n`git pull origin master`\n\n#### (2) Install\n\n`pip install -e .`\n\nUsing the flag ``--user``, we can tell ``pip`` to install the package to the current users's home directory, instead of system-wide. This option might require you to update your system's ``PATH`` variable accordingly.\n\n##### ...with GPU support\n\nFor GPU support, the optional PyTorch dependency needs to be installed.\n\n`pip install -e .[torch]`\n\n## Reconstruct your first force field\n\nDownload one of the example datasets:\n\n`sgdml-get dataset ethanol_dft`\n\nTrain a force field model:\n\n`sgdml all ethanol_dft.npz 200 1000 5000`\n\n## Query a force field\n\n```python\nimport numpy as np\nfrom sgdml.predict import GDMLPredict\nfrom sgdml.utils import io\n\nr,_ = io.read_xyz('examples/geometries/ethanol.xyz') # 9 atoms\nprint r.shape # (1,27)\n\nmodel = np.load('models/ethanol.npz')\ngdml = GDMLPredict(model)\ne,f = gdml.predict(r)\nprint e.shape # (1,)\nprint f.shape # (1,27)\n```\n\n### ...with GPU support\n\nSetting ``use_torch=True`` when instantiating the predictor redirects all calculations to PyTorch.\n\n```python\ngdml = GDMLPredict(model, use_torch=True)\n```\n\n**_NOTE:_** PyTorch must be installed with GPU support, otherwise the CPU is used. However, we recommend performing CPU calculations without PyTorch for optimal performance.\n\n\n## References\n\n* [1] Chmiela, S., Tkatchenko, A., Sauceda, H. E., Poltavsky, I., Sch\u00fctt, K. T., M\u00fcller, K.-R.,\n*Machine Learning of Accurate Energy-conserving Molecular Force Fields.*\nScience Advances, 3(5), e1603015 (2017) \n[10.1126/sciadv.1603015](http://dx.doi.org/10.1126/sciadv.1603015)\n\n* [2] Chmiela, S., Sauceda, H. E., M\u00fcller, K.-R., & Tkatchenko, A.,\n*Towards Exact Molecular Dynamics Simulations with Machine-Learned Force Fields.*\nNature Communications, 9(1), 3887 (2018) \n[10.1038/s41467-018-06169-2](https://doi.org/10.1038/s41467-018-06169-2)\n\n* [3] Chmiela, S., Sauceda, H. E., Poltavsky, I., M\u00fcller, K.-R., & Tkatchenko, A.,\n*sGDML: Constructing Accurate and Data Efficient Molecular Force Fields Using Machine Learning.*\nComputer Physics Communications, 240, 38-45 (2019)\n[10.1016/j.cpc.2019.02.007](https://doi.org/10.1016/j.cpc.2019.02.007)\n\n* [4] Sauceda, H. E., Chmiela, S., Poltavsky, I., M\u00fcller, K.-R., & Tkatchenko, A.,\n*Molecular Force Fields with Gradient-Domain Machine Learning: Construction and Application to Dynamics of Small Molecules with Coupled Cluster Forces.*\nThe Journal of Chemical Physics, 150, 114102 (2019)\n[10.1063/1.5078687](https://doi.org/10.1063/1.5078687)\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://www.sgdml.org", "keywords": "", "license": "LICENSE.txt", "maintainer": "", "maintainer_email": "", "name": "sgdml", "package_url": "https://pypi.org/project/sgdml/", "platform": "", "project_url": "https://pypi.org/project/sgdml/", "project_urls": { "Homepage": "http://www.sgdml.org" }, "release_url": "https://pypi.org/project/sgdml/0.3.2/", "requires_dist": [ "numpy (>=1.13.0)", "scipy (>=1.1.0)", "ase (>=3.16.2)", "torch; extra == 'torch'" ], "requires_python": "", "summary": "Reference implementation of the GDML and sGDML force field models.", "version": "0.3.2" }, "last_serial": 5698529, "releases": { "0.2.0.dev0": [ { "comment_text": "", "digests": { "md5": "4c916504265dbf1ab0e4c441e952aa9d", "sha256": "8d4fa05014dfa71e3f9a3ea9114a98ca78d5f63df9abe701510b28c154d4272f" }, "downloads": -1, "filename": "sgdml-0.2.0.dev0-py2-none-any.whl", "has_sig": false, "md5_digest": "4c916504265dbf1ab0e4c441e952aa9d", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 46009, "upload_time": "2019-01-22T07:50:17", "url": "https://files.pythonhosted.org/packages/ec/7f/ac08c89b94fe6cb82d119c68621ed6734daabf16506a8a79603b712b7622/sgdml-0.2.0.dev0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b9c3707a3678f04804676c414351cb95", "sha256": "048d33410a8403bbee5d45ff2ce84433b4596f7fc7f7f9a0fe52707fe30915cf" }, "downloads": -1, "filename": "sgdml-0.2.0.dev0.tar.gz", "has_sig": false, "md5_digest": "b9c3707a3678f04804676c414351cb95", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35373, "upload_time": "2019-01-22T07:50:20", "url": "https://files.pythonhosted.org/packages/e4/68/6b13943902d3af628fe4ee4a43cd060252cb018a0e3d47c9c05d020698fc/sgdml-0.2.0.dev0.tar.gz" } ], "0.2.0.dev1": [ { "comment_text": "", "digests": { "md5": "1f6fa2f045a2eb70da055d225767d3c0", "sha256": "bc95d8eb44e7db0b0cbdd8e17088328d347a57e7021c899fbd128597b22a4e0d" }, "downloads": -1, "filename": "sgdml-0.2.0.dev1-py2-none-any.whl", "has_sig": false, "md5_digest": "1f6fa2f045a2eb70da055d225767d3c0", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 46350, "upload_time": "2019-01-22T08:11:36", "url": "https://files.pythonhosted.org/packages/85/e1/87bea2e80e6b6fc60f0d8f4d9cf9a13f8a22d64b83330395f7980bcba2f0/sgdml-0.2.0.dev1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3f5fc0524940031d02ab59328fcf78fa", "sha256": "5f76c7b54ea4b78dad5561270aa1310d86184ecd3c55d2d8ea751d025ca19139" }, "downloads": -1, "filename": "sgdml-0.2.0.dev1.tar.gz", "has_sig": false, "md5_digest": "3f5fc0524940031d02ab59328fcf78fa", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 36100, "upload_time": "2019-01-22T08:11:39", "url": "https://files.pythonhosted.org/packages/eb/54/eb72fa14c914b6ba2900b8126821bed4d335b19fd3e098469fc2356ab1bd/sgdml-0.2.0.dev1.tar.gz" } ], "0.2.1.dev0": [ { "comment_text": "", "digests": { "md5": "e93b4d921add7331fda936d2d91f1f74", "sha256": "906e0e8d49c5c3692e96734b71f327aa038c58ddecc2d98ebc6b8748704216bb" }, "downloads": -1, "filename": "sgdml-0.2.1.dev0-py2-none-any.whl", "has_sig": false, "md5_digest": "e93b4d921add7331fda936d2d91f1f74", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 48549, "upload_time": "2019-01-29T13:17:33", "url": "https://files.pythonhosted.org/packages/18/db/f409d48dcd6dc4453d7941a7791be7766e7c9afdd7a3df9de4312a81341b/sgdml-0.2.1.dev0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "86a61c736b6d8c010776cc52d54b6b41", "sha256": "8392c3168bee73ff2bc4b3136b7b3d1f83360e9173b8f006eda0acc6d7f9402a" }, "downloads": -1, "filename": "sgdml-0.2.1.dev0.tar.gz", "has_sig": false, "md5_digest": "86a61c736b6d8c010776cc52d54b6b41", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 38311, "upload_time": "2019-01-29T13:17:35", "url": "https://files.pythonhosted.org/packages/6a/83/6204451d99f9f6113deff4d7116d25198d9119ad738050d541b34b505dd8/sgdml-0.2.1.dev0.tar.gz" } ], "0.2.3": [ { "comment_text": "", "digests": { "md5": "2f5d0939bb62f8f2e45db998267e637e", "sha256": "639b6d8f002b5220c4e49871c576f3a74a21b34f6ba0f870fe73ddc780b20e26" }, "downloads": -1, "filename": "sgdml-0.2.3-py2-none-any.whl", "has_sig": false, "md5_digest": "2f5d0939bb62f8f2e45db998267e637e", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 49657, "upload_time": "2019-02-24T16:55:18", "url": "https://files.pythonhosted.org/packages/b8/9a/e25e7faaa3d50600bb6218c729161ffffe98db52fdba8ea30e39dcbde546/sgdml-0.2.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e3f584be11d3157d236ac276d951ffb8", "sha256": "05e78243fbf774d75d19be4f09d3a6de105062c37ace512a1770b1eef074b782" }, "downloads": -1, "filename": "sgdml-0.2.3.tar.gz", "has_sig": false, "md5_digest": "e3f584be11d3157d236ac276d951ffb8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39622, "upload_time": "2019-02-24T16:55:21", "url": "https://files.pythonhosted.org/packages/ce/55/0c50667d67b58781bce06ad5bbfe420f97fb3b328204043affe6fca469b3/sgdml-0.2.3.tar.gz" } ], "0.2.3.dev0": [ { "comment_text": "", "digests": { "md5": "eabbd27241661755d1a48dd5c7df799b", "sha256": "7e0da5892992b864fe64f28055035a6c68815952828504c823d92125ba1a2ea7" }, "downloads": -1, "filename": "sgdml-0.2.3.dev0-py2-none-any.whl", "has_sig": false, "md5_digest": "eabbd27241661755d1a48dd5c7df799b", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 49770, "upload_time": "2019-02-24T16:54:52", "url": "https://files.pythonhosted.org/packages/bb/2a/ac15f428e4d31e15a8400b14fe8965dc41dc2286c91c5379c107d7b642f3/sgdml-0.2.3.dev0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "37d633a9a30f72bc1685ad5e433a7ab1", "sha256": "20cf82bcd3c65f80c9d45a39e27f0e0f82d2436a360f08c7829ba97fda4b79d6" }, "downloads": -1, "filename": "sgdml-0.2.3.dev0.tar.gz", "has_sig": false, "md5_digest": "37d633a9a30f72bc1685ad5e433a7ab1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 39640, "upload_time": "2019-02-24T16:54:54", "url": "https://files.pythonhosted.org/packages/b6/59/dc28954c985c9e64a1079f3b8be23e6e70242fe470e322a36a80cf2485e3/sgdml-0.2.3.dev0.tar.gz" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "437695df6cf2e17fb2fd3bf9e6b3ece5", "sha256": "9a84ec8ca0403e6065621283618b8f7cd9d5f91917b66d5362ca5efac574e442" }, "downloads": -1, "filename": "sgdml-0.3.2-py2-none-any.whl", "has_sig": false, "md5_digest": "437695df6cf2e17fb2fd3bf9e6b3ece5", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 58157, "upload_time": "2019-08-19T14:02:05", "url": "https://files.pythonhosted.org/packages/7c/2c/be839266799e299ac8f2ff4c87f143c2e7ba98bdb11503de00d30dce9bbd/sgdml-0.3.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6b02a076c2cc31f62469ad9e8811b7ad", "sha256": "56146e2b42a7e08e0750cd27da8973b59a7b3059f4e323b13fd8febac7e19af5" }, "downloads": -1, "filename": "sgdml-0.3.2.tar.gz", "has_sig": false, "md5_digest": "6b02a076c2cc31f62469ad9e8811b7ad", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 47819, "upload_time": "2019-08-19T14:02:08", "url": "https://files.pythonhosted.org/packages/5f/b8/62cfe76b91ba838030dcf0db0f49578c49043ca6aacc39d10b81be6fbdec/sgdml-0.3.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "437695df6cf2e17fb2fd3bf9e6b3ece5", "sha256": "9a84ec8ca0403e6065621283618b8f7cd9d5f91917b66d5362ca5efac574e442" }, "downloads": -1, "filename": "sgdml-0.3.2-py2-none-any.whl", "has_sig": false, "md5_digest": "437695df6cf2e17fb2fd3bf9e6b3ece5", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 58157, "upload_time": "2019-08-19T14:02:05", "url": "https://files.pythonhosted.org/packages/7c/2c/be839266799e299ac8f2ff4c87f143c2e7ba98bdb11503de00d30dce9bbd/sgdml-0.3.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6b02a076c2cc31f62469ad9e8811b7ad", "sha256": "56146e2b42a7e08e0750cd27da8973b59a7b3059f4e323b13fd8febac7e19af5" }, "downloads": -1, "filename": "sgdml-0.3.2.tar.gz", "has_sig": false, "md5_digest": "6b02a076c2cc31f62469ad9e8811b7ad", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 47819, "upload_time": "2019-08-19T14:02:08", "url": "https://files.pythonhosted.org/packages/5f/b8/62cfe76b91ba838030dcf0db0f49578c49043ca6aacc39d10b81be6fbdec/sgdml-0.3.2.tar.gz" } ] }