"""
pylift.__init__ module
License: The MIT License (MIT)
Copyright (c) 2024 Brandon C. Tapia
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
[docs]
def pylift_help():
"""
pylift.pylift_help
Prints location of resources
Arguments:
None
Returns:
None
"""
print(
"""
Examples:
PyLIFT/Examples/...
all_atom: How to use PyLIFT to generate all atom LAMMPS input files
united_atom: How to use PyLIFT to generate united atom LAMMPS input molecules
ff_update: How to use PyLIFT to generate an updated forcefield JSON file by yourself
Documentation:
https://pylift-mit.readthedocs.io/en/latest/pylift.html
Source code:
Available at https://github.com/bctapia/PyLIFT
Developer:
Brandon C. Tapia / bctapia@mit.edu
Questions?
Please shoot me an email (bctapia@mit.edu) or post on the PyLIFT GitHub page (https://github.com/bctapia/PyLIFT)
"""
)