# NewtonNet
A Newtonian message passing network for deep learning of interatomic potentials and forces
## Installation and Dependencies
We recommend using conda environment to install dependencies of this library.
Please install (or load) conda and then proceed with the following commands:
conda create --name newtonnet python=3.10
conda activate newtonnet
Now, you can install NewtonNet in the conda environment by cloning this repository:
git clone https://github.com/THGLab/NewtonNet.git
and then runnig the following command inside the NewtonNet repository (where you have access to setup.py):
pip install -e .
Once you finished installations succesfully, you will be able to run NewtonNet modules
anywhere on your computer as long as the `newtonnet` environment is activated.
## Guidelines
- You can find several run files inside the scripts directory that rely on the implemented modules in the NewtonNet library.
- The run scripts need to be accompanied with a yaml configuration file.
- The documentation of the modules are available at most cases. Please look up local classes or functions
and consult with the docstrings in the code.
Raw data
{
"_id": null,
"home_page": "",
"name": "NewtonNet",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Machine Learning,Data Mining,Quantum Chemistry,Molecular Dynamics",
"author": "Teresa Head-Gordon",
"author_email": "thg@berkeley.edu",
"download_url": "https://files.pythonhosted.org/packages/6b/c6/80f1dee95cf70de0f13a3f32a8a01c6f942290bc01a401c4315db1206adb/NewtonNet-1.1.1.tar.gz",
"platform": null,
"description": "# NewtonNet\nA Newtonian message passing network for deep learning of interatomic potentials and forces\n\n## Installation and Dependencies\nWe recommend using conda environment to install dependencies of this library.\nPlease install (or load) conda and then proceed with the following commands:\n\n conda create --name newtonnet python=3.10\n conda activate newtonnet\n\nNow, you can install NewtonNet in the conda environment by cloning this repository:\n\n git clone https://github.com/THGLab/NewtonNet.git\n\nand then runnig the following command inside the NewtonNet repository (where you have access to setup.py):\n\n pip install -e .\n\nOnce you finished installations succesfully, you will be able to run NewtonNet modules\nanywhere on your computer as long as the `newtonnet` environment is activated.\n\n\n## Guidelines\n- You can find several run files inside the scripts directory that rely on the implemented modules in the NewtonNet library. \n\n- The run scripts need to be accompanied with a yaml configuration file.\n\n- The documentation of the modules are available at most cases. Please look up local classes or functions\nand consult with the docstrings in the code.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Newtonian message passing network for deep learning of interatomic potentials and forces",
"version": "1.1.1",
"project_urls": {
"Source": "https://github.com/THGLab/NewtonNet"
},
"split_keywords": [
"machine learning",
"data mining",
"quantum chemistry",
"molecular dynamics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6bc680f1dee95cf70de0f13a3f32a8a01c6f942290bc01a401c4315db1206adb",
"md5": "f0def4f1baae96ff6e99ad2ec074f81e",
"sha256": "f68e3c1cafbf08d84d11be9fdd9f58d920a5b9156557a0ab9fe834640ebd82a1"
},
"downloads": -1,
"filename": "NewtonNet-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "f0def4f1baae96ff6e99ad2ec074f81e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 41852,
"upload_time": "2023-11-12T20:38:40",
"upload_time_iso_8601": "2023-11-12T20:38:40.008080Z",
"url": "https://files.pythonhosted.org/packages/6b/c6/80f1dee95cf70de0f13a3f32a8a01c6f942290bc01a401c4315db1206adb/NewtonNet-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-12 20:38:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "THGLab",
"github_project": "NewtonNet",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "newtonnet"
}