|
1 | | -# smatool |
| 1 | +--- |
| 2 | + |
| 3 | +# SMATool - Strength of Materials Analysis Toolkit |
| 4 | + |
| 5 | + |
| 6 | +**`SMATool`** -- Strength of Materials Analysis Toolkit is a comprehensive computational package developed to evaluate the tensile, shear, biaxial, and indentation strength (Vickers' hardness) of materials at zero temperature (using density functional theory) and finite temperature (using ab-initio molecular dynamics). Integrating advanced algorithms and leveraging the capabilities of well-established electronic structure codes like VASP and QE as the stress calculator, SMATool provides a robust platform for analyzing the strength of 1D, 2D, and 3D materials. |
| 7 | + |
| 8 | +## Importance of SMATool |
| 9 | +The significance of SMATool lies in its ability to provide accurate and efficient strength parameters, which are crucial in material design and analysis. Understanding these mechanical properties helps in predicting material behavior under different loading conditions and in different environments, contributing to the development of materials with optimized performance characteristics. |
| 10 | + |
| 11 | +## Types of Strengths within SMATool |
| 12 | +1. *Uniaxial Tensile Strength:* The maximum stress a material can withstand while being stretched or pulled before failure. Tensile strength is crucial in applications where materials are subject to tension. The tensile strength can be computed along the various directions: x, y, and z, and along the critical plane directions. |
| 13 | + |
| 14 | +2. *Biaxial Strength:* The strength of a material when subjected to biaxial stress conditions. This is important for materials used in applications where they are exposed to stresses in two perpendicular directions. |
| 15 | + |
| 16 | +3. *Shear Strength:* This measures a material's ability to resist shear loads, which is vital in understanding how materials will behave when forces are applied parallel to a material's surface. The shear strength can be determined along the critical plane directions and slip directions. |
| 17 | + |
| 18 | + |
| 19 | +4. *Indentation Strength:* The measure of the resistance of a material to deformation under localized compressive forces. This can be used to quantify the Vickers' hardness of a material. |
| 20 | + |
| 21 | +Additionally, the SMATool package computes the yield strength for each of the strengths above, and the corresponding energy storage capacity (in MJ/L and Wh/Kg) of the material at the ultimate strain. |
| 22 | + |
| 23 | +## SMATool Stress Calculators |
| 24 | +SMATool utilizes VASP (Vienna Ab initio Simulation Package) and QE (Quantum Espresso) as its calculator, ensuring high accuracy and reliability. These powerful electronic structure codes, combined with the ASE (Atomic Simulation Environment) backend, enable detailed and precise material analysis. If you're interested in other electronic structure code as the stress calculation, we will be more than happy to collaborate in such implementations. |
| 25 | + |
| 26 | + |
| 27 | +## Installation |
| 28 | +**SMATool** offers straightforward installation options suitable for various user preferences as explained below. We note that in all the installation options, all the libraries and dependables are automatically determined and installed alongside the SMATool. |
| 29 | + |
| 30 | +1. **Using pip**: Our recommended way to install the **SMATool** package is using pip. |
| 31 | + - Quickly install the latest version of the SMATool package with pip by executing: |
| 32 | + ``` |
| 33 | + pip install -U smatool |
| 34 | + ``` |
| 35 | + |
| 36 | +2. **From Source Code**: |
| 37 | + - Alternatively, users can download the source code with: |
| 38 | + ``` |
| 39 | + git clone [[email protected]:gmp007/smatool.git] |
| 40 | + ``` |
| 41 | + - Then, install SMATool by navigating to the master directory and running: |
| 42 | + ``` |
| 43 | + pip install . |
| 44 | + ``` |
| 45 | + |
| 46 | +3. **Installation via setup.py**: |
| 47 | + - SMATool can also be installed using the `setup.py` script: |
| 48 | + ``` |
| 49 | + python setup.py install [--prefix=/path/to/install/] |
| 50 | + ``` |
| 51 | + - The optional `--prefix` argument is useful for installations in environments like shared High-Performance Computing (HPC) systems, where administrative privileges might be restricted. |
| 52 | + - Please note that while this method remains supported, its usage is gradually declining in favor of more modern installation practices. We only recommend this installation option where standard installation methods like `pip` are not applicable. |
| 53 | + |
| 54 | +## Usage and Running SMATool |
| 55 | + |
| 56 | +The best way to learn how to use the SMATool package is to start with the provided examples folder. The key steps for initializing SMATool follows: |
| 57 | + |
| 58 | +1. **Create a Calculation Directory**: |
| 59 | + - Start by creating a directory for your calculations. |
| 60 | + - Run `smatool -0` to generate main input template of the SMATool, which is the `smatool.in`. |
| 61 | + |
| 62 | +2. **Modify Input Files**: |
| 63 | + - Customize the generated files according to your project's requirements, choose the code type between VASP and QE, and specify the directory of your potential files. |
| 64 | + |
| 65 | +3. **Initialize the Job**: |
| 66 | + - Execute `smatool` to begin the calculation process. |
| 67 | + |
| 68 | +4. **Understanding SMATool Options**: |
| 69 | + - The main input file `smatool.in` includes descriptive text for each flag, making it user-friendly. |
| 70 | + |
| 71 | +## Citing SMATool |
| 72 | +If you have used the SMATool package in your research, please cite: |
| 73 | + - [SMATool: An automated toolkit for strength of materials](https://doi.org/10.1016/XXXXX) - |
| 74 | + |
| 75 | +@article{Ekuma2024, |
| 76 | + title = {SMATool: Strength of Materials Analysis Toolkit}, |
| 77 | + journal = {XXX}, |
| 78 | + volume = {XXX}, |
| 79 | + pages = {XXX}, |
| 80 | + year = {2024}, |
| 81 | + doi = {https://doi.org/10.1016/XXXX}, |
| 82 | + url = {XXX}, |
| 83 | + author = {XXXX} |
| 84 | +} |
| 85 | + |
| 86 | +## SMATool Utility |
| 87 | +ASP electronic structure calculations come with proprietary pseudopotentials included in the package. In contrast, Quantum Espresso (QE) is open source, offering a variety of sources for obtaining pseudopotentials. While no specific pseudopotential database is officially recommended for QE, we prefer the norm-conserving [Pdojo pseudopentials](http://www.pseudo-dojo.org/). The SMATool computational toolkit includes an automated utility package, `qepotential`, located in the utility folder. This tool automates the generation of pseudopotentials from the Pdojo website for all materials required to run the SMATool package with QE as the calculator. Users can also specify custom requirements in the `pseudo.info` input file. The SMATool utility package saves the potentials of various elements as `element_pdojo.upf` in the `qe_potentials` folder. |
| 88 | + |
| 89 | + |
| 90 | +## Contact Information |
| 91 | +Please if you find a bug, want to extend the SMATool computational toolkit, or have an idea that you would want us to incorporate, please reach out to us. Our team is dedicated to supporting your work and enhancing capabilities and efficiency of the SMATool package. |
| 92 | + |
| 93 | +Feel free to contact us via email: |
| 94 | + |
| 95 | + |
| 96 | +Your feedback and questions are invaluable to us, and we look forward to hearing from you. |
| 97 | + |
| 98 | +## License |
| 99 | + |
| 100 | +This project is licensed under the GNU GPL version 3 - see the [LICENSE](LICENSE) file for details. |
| 101 | + |
| 102 | +## Acknowledgments |
| 103 | + |
| 104 | +- This work was supported by the U.S. Department of Energy, Office of Science, Basic Energy Sciences under Award DOE-SC0024099. |
| 105 | + |
| 106 | +--- |
0 commit comments