diff --git a/README.md b/README.md index 8372cb40ae4a9de8dd2c5bc59d9ae5e6f697eb07..f48d94ca8750235bf195c2c5a6269b2d636910bc 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,28 @@ -# MachineLearning_IJL + +### Prerequisites + +The codes uses SOAP descriptors throught the Dscribe Library, Machine Learning tools with scikit-learn library and the Atomic Simulation Environment (ASE) Library. + +## Usage + +This code purpose is to recreate Energy Adsorption Map (EAM) using machine learning. + + +<!-- CONTACT --> +## Contact + +Your Name - + +Project Link: + + + +<!-- ACKNOWLEDGMENTS --> +## Acknowledgments + +Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off! + +* [Choose an Open Source License](https://choosealicense.com) + +