➕ description

.zenodo.json

@@ -1,7 +1,7 @@
 {
     "title": "Enhancing the ReaxFF protocol",
     "version": "1.0.0-alpha",
-    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Eget arcu dictum varius duis at consectetur lorem donec massa. Dui vivamus arcu felis bibendum ut tristique et egestas quis. Viverra ipsum nunc aliquet bibendum. Eget felis eget nunc lobortis mattis aliquam faucibus. Porttitor massa id neque aliquam. Est ullamcorper eget nulla facilisi etiam dignissim diam quis enim. Tempor orci eu lobortis elementum nibh tellus. Purus non enim praesent elementum facilisis leo vel. Dui accumsan sit amet nulla facilisi morbi tempus iaculis urna. Diam maecenas ultricies mi eget. Consectetur adipiscing elit pellentesque habitant. Tincidunt nunc pulvinar sapien et.\nNulla facilisi nullam vehicula ipsum. Ac placerat vestibulum lectus mauris ultrices. Molestie ac feugiat sed lectus. Eu non diam phasellus vestibulum lorem sed risus. In fermentum posuere urna nec. Amet aliquam id diam maecenas ultricies mi eget mauris pharetra. Magna fermentum iaculis eu non diam phasellus vestibulum lorem. Nam libero justo laoreet sit. Aliquam faucibus purus in massa tempor. Turpis egestas pretium aenean pharetra magna ac placerat. Tempus urna et pharetra pharetra massa massa. Felis imperdiet proin fermentum leo. Vel eros donec ac odio tempor orci dapibus ultrices in. Enim nunc faucibus a pellentesque sit amet. Suspendisse potenti nullam ac tortor vitae purus faucibus ornare. Nibh tellus molestie nunc non blandit massa. In nulla posuere sollicitudin aliquam ultrices sagittis orci a scelerisque. Felis imperdiet proin fermentum leo vel orci porta. Condimentum mattis pellentesque id nibh tortor id aliquet. Tellus mauris a diam maecenas.\nScelerisque fermentum dui faucibus in ornare quam viverra orci sagittis. Etiam sit amet nisl purus in mollis nunc sed. Justo laoreet sit amet cursus sit. Turpis massa sed elementum tempus egestas sed sed risus pretium. Maecenas accumsan lacus vel facilisis. Viverra justo nec ultrices dui. Ultrices tincidunt arcu non sodales neque. In dictum non consectetur a erat nam at lectus urna. At risus viverra adipiscing at in. Id diam vel quam elementum pulvinar etiam non. Turpis nunc eget lorem dolor. Iaculis nunc sed augue lacus viverra. Risus commodo viverra maecenas accumsan lacus vel facilisis. Non arcu risus quis varius. Ut ornare lectus sit amet. Fringilla est ullamcorper eget nulla facilisi etiam dignissim diam quis. Justo nec ultrices dui sapien eget mi.\nOrci porta non pulvinar neque laoreet suspendisse. Sit amet justo donec enim. Amet consectetur adipiscing elit duis. Feugiat pretium nibh ipsum consequat nisl vel. Enim praesent elementum facilisis leo. Feugiat in fermentum posuere urna. Dictum varius duis at consectetur lorem donec massa sapien. Diam quam nulla porttitor massa id. Est ultricies integer quis auctor elit sed vulputate. Sed sed risus pretium quam vulputate dignissim suspendisse in est. Eu mi bibendum neque egestas congue.\nQuam vulputate dignissim suspendisse in. Mauris ultrices eros in cursus turpis. Quis varius quam quisque id diam vel quam elementum. Aliquam ultrices sagittis orci a scelerisque. Tincidunt vitae semper quis lectus nulla at volutpat diam ut. Risus feugiat in ante metus dictum at tempor commodo ullamcorper. Ut enim blandit volutpat maecenas volutpat. Amet consectetur adipiscing elit duis tristique sollicitudin nibh. Augue interdum velit euismod in pellentesque massa placerat duis ultricies. Ut venenatis tellus in metus vulputate. Sit amet justo donec enim diam. Sed cras ornare arcu dui vivamus arcu felis bibendum. Orci eu lobortis elementum nibh tellus molestie nunc non blandit. Metus aliquam eleifend mi in nulla posuere. Habitant morbi tristique senectus et netus et. Pretium quam vulputate dignissim suspendisse in est ante in. Purus non enim praesent elementum.",
+    "description": "<p>This repository contains the jupyter notebooks used to re-parametrize the ReaxFF force field for LiF, an inorganic compound. The purpose of the set of notebooks is to facilitate the reparameterization ReaxFF force field for LiF. The results and method used were published in the article <a href=\"https://doi.org/TBD\">Enhancing ReaxFF for Molecular Dynamics Simulations of Lithium-Ion Batteries: An interactive reparameterization protocol</a>.</p>\n<p>The database containing the simulation data from <em>ab initio</em> simulations obtained from this protocol is published in <a href=\"https://github.com/paolodeangelis/Enhancing_ReaxFF_DFT_database\">Enhancing ReaxFF repository DFT Database</a>.</p>\n<p>The Jupyter Notebooks provided here are designed to facilitate the configuration building, execution of DFT simulations, and optimization of the ReaxFF potential. To manage the complexity of the overall operation, we have divided the process into four main Jupyter Notebooks, with an additional auxiliary notebook.</p>\n<p>Each notebook can be executed independently, allowing for flexibility in adapting the workflow to optimize the ReaxFF potential for different compounds with minimal modifications.</p>\n<p>The four main Jupyter Notebooks cover various aspects of the workflow, including configuration setup, DFT simulations, and ReaxFF optimization. By following the sequence of these notebooks, you will be able to efficiently perform the entire process, from initial configuration generation to the optimization of the ReaxFF potential.</p>\n<strong id=\"installation\">Installation</strong>\n<p>To use the database and interact with it, ensure that you have the following Python requirements installed:</p>\n<p><em>Minimum Requirements:</em></p>\n<ul>\n<li>Python 3.8 or above</li>\n<li>Atomic Simulation Environment (ASE) library</li>\n<li>Jupyter Lab</li>\n</ul>\n<p><em>Requirements for Re-running or Performing New Simulations:</em></p>\n<ul>\n<li>SCM (Software for Chemistry &amp; Materials) Amsterdam Modeling Suite</li>\n<li>PLAMS (Python Library for Automating Molecular Simulation) library</li>\n</ul>\n<p><em>Requirements for Re-running ReaxFF optimization:</em></p>\n<ul>\n<li>AMS (Amsterdam Modeling Suite) Python Stack (<a href=\"https://www.scm.com/doc/Scripting/Python_Stack/Python_Stack.html\">more info here</a>)</li>\n</ul>\n<p>You can install the required Python packages using pip:</p>\n<pre class=\"shell\"><code>pip install -r requirements.txt</code></pre>\n<p><strong>Warning</strong></p>\n<p>This do not include the ParAMS packages since is available only in AMS Python Stack.</p>\n<p>See instruction below.</p>\n<pre class=\"shell\"><code>export SCM_PYTHONDIR=$(pwd)/venv\n$AMSBIN/amspython --install_venv\nsource venv/AMSYYYY.X.venv/bin/activate # Replace YYYY.X with the correct AMS version</code></pre>\n<p><strong>Warning</strong></p>\n<p>Make sure to have the appropriate licenses and installations of SCM Amsterdam Modeling Suite and any other necessary software for running simulations.</p>\n<h3 id=\"configure-material-project-api\">Configure <code>Material Project API</code></h3>\n<p><em>Get <em>Material Project</em> API key</em></p>\n<p>Access to <a href=\"https://materialsproject.org/\">Material Project</a> and follow the istruction on the <a href=\"https://materialsproject.org/api\">documentation</a></p>\n<h4 id=\"make-the-configuration-file\">Make the configuration file</h4>\n<ol type=\"1\">\n<li>Run the script replacing <code>&lt;MATERIAL_PROJECT_KEY&gt;</code> with the Material Project API key.</li>\n</ol>\n<pre class=\"shell\"><code>python tools/mpinterface_setup.py -k &lt;MATERIAL_PROJECT_KEY&gt;</code></pre>\n<strong id=\"folder-structure\">Folder Structure</strong>\n<p>The repository has the following folder structure:</p>\n<pre>\n<code class=\"language-bash\">\n    .\n    \u251c\u2500\u2500 CREDITS.md\n    \u251c\u2500\u2500 LICENSE\n    \u251c\u2500\u2500 README.md\n    \u251c\u2500\u2500 requirements.txt\n    \u251c\u2500\u2500 assets\n    \u251c\u2500\u2500 data\n    \u2502   \u2514\u2500\u2500 ffield.reax.optimized.ff\n    \u251c\u2500\u2500 tools\n    \u251c\u2500\u2500 JNB1-Initial_configrations.ipynb\n    \u251c\u2500\u2500 JNB2-Simulations.ipynb\n    \u251c\u2500\u2500 JNB3-Build_traingset.ipynb\n    \u251c\u2500\u2500 preJNB4-ReaxFF_optimization.ipynb\n    \u2514\u2500\u2500 JNB4-ReaxFF_optimization.ipynb\n</code>\n</pre>\n<ul>\n<li><code>CREDITS.md</code>: This file acknowledges and credits the individuals or organizations that have contributed to the repository.</li>\n<li><code>LICENSE</code>: This file contains the license information for the repository (CC BY 4.0). It specifies the terms and conditions under which the repository\u2019s contents are distributed and used.</li>\n<li><code>README.md</code>: This file (repository overview and instructions).</li>\n<li><code>requirements.txt</code>: This file lists the required Python packages and their versions (see <a href=\"#installation\">installation section</a>).</li>\n<li><code>assets</code>: This folder contains any additional assets, such as images or documentation, related to the repository.</li>\n<li><code>data</code>: This folder contains the data files resulted from this work.\n<ul>\n<li><code>ffield.reax.optimized.ff</code>: This file is the optimized ReaxFF resulted from using these Jupyter notebooks, as explained in the related <a href=\"https://doi.org/TBD\">journal article</a>.</li>\n</ul></li>\n<li><code>notebooks</code>: This folder contains Jupyter notebooks that provide demonstrations and examples of how to use and analyze the database.\n<ul>\n<li><code>JNB1-Initial_configurations.ipynb</code>: Jupyter Notebook where the protocol is initialized by querying the <em>Materials Project</em> database, downloading the unit crystals, and producing all the initial configurations for the DFT simulations using the <em>pymatgen</em> library.</li>\n<li><code>JNB2-Simulations.ipynb</code>: This notebook performs the simulations using BAND and DFTB codes available in the Amsterdam Modeling Suite. The simulations are performed in parallel using the <em>PLAMS</em> library and <em>SLURM</em> scheduler.</li>\n<li><code>JNB3-Build_trainingset.ipynb</code>: Here, the quantities needed for the database are extracted and tuned to favor accuracy on the energy.</li>\n<li><code>preJNB4-ReaxFF_optimization.ipynb</code>: This is an auxiliary Notebook where the old ReaxFF is converted into a Python object, and it is possible to select the subset of coefficients related to specific interactions to change during the optimization (e.g., bond, van der Waals, angular, etc.).</li>\n<li><code>JNB4-ReaxFF_optimization.ipynb</code>: This notebook takes the database and the ReaxFF Python object to perform a multi-objective optimization and find the new ReaxFF potential that minimizes the Sum of Squared Errors (SSE).</li>\n</ul></li>\n<li><code>tools</code>: This directory contains a collection of Python modules and scripts.</li>\n</ul>\n<p><strong>Note</strong></p>\n<p>Please note that the Jupyter notebooks <code>preJNB4-ReaxFF_optimization.ipynb</code> and <code>JNB4-ReaxFF_optimization.ipynb</code> can be run multiple times to gradually optimize the ReaxFF potential. This optimization process involves selecting different subsets of parameters, as demonstrated in the workflow and described in the accompanying <a href=\"https://doi.org/TBD\">article</a>.</p>\n<strong id=\"contributing\">Contributing</strong>\n<p>At the moment the contribution to this codes is close since all the work is under peer-review revision.</p>\n<strong id=\"license\">License</strong>\n<p>The contents of this repository are licensed under the <a href=\"http://creativecommons.org/licenses/by/4.0/\">Creative Commons Attribution 4.0 International License</a>.</p>\n<strong id=\"acknowledgments\">Acknowledgments</strong>\n<p>This project has received funding from the European Union\u2019s <a href=\"https://ec.europa.eu/programmes/horizon2020/en\">Horizon 2020 research and innovation programme</a> under grant agreement <a href=\"https://cordis.europa.eu/project/id/957189\">No 957189</a>. The project is part of <a href=\"https://battery2030.eu/\">BATTERY 2030+</a>, the large-scale European research initiative for inventing the sustainable batteries of the future.</p>\n<p>The authors also acknowledge that the simulation results of this database have been achieved using the <a href=\"https://prace-ri.eu/hpc-access/deci-access/\">DECI</a> resource <a href=\"https://www.archer2.ac.uk/\">ARCHER2</a> based in UK at <a href=\"https://www.epcc.ed.ac.uk/\">EPCC</a> with support from the <a href=\"https://prace-ri.eu/\">PRACE</a> aisbl.</p>",
     "creators": [
         {
             "name": "De Angelis, Paolo",