| Name | aimsgb JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | http://aimsgb.org |
| Summary | aimsgb is a python library for generatng the atomic coordinates of periodic grain boundaries.Copyright © 2018 The Regents of the University of California.All Rights Reserved. See more in Copyright. |
| upload_time | 2024-03-15 04:27:06 |
| maintainer | Jianli Cheng, Sicong JIANG, and Kesong YANG |
| docs_url | None |
| author | Jianli Cheng and Kesong YANG |
| requires_python | >=3.9 |
| license | |
| keywords |
material science
grain boundary
molecular simulation
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Introduction
============
aimsgb, an efficient and open-source Python library for generating atomic coordinates in periodic grain boundary models. It is designed to
construct various grain boundary structures from cubic and non-cubic initial
configurations. A convenient command line tool has also been provided to enable
easy and fast construction of tilt and twist boundaries by assigining the degree
of fit (Σ), rotation axis, grain boundary plane and initial crystal structure.
aimsgb is expected to greatly accelerate the theoretical investigation of
grain boundary properties and facilitate the experimental analysis of grain
boundary structures as well.
A reference for the usage of aimsGB software is:
Jianli Cheng, Jian Luo, and Kesong Yang, Aimsgb: An Algorithm and OPen-Source Python Library to Generate Periodic Grain Boundary Structures, Comput. Mater. Sci. 155, 92-103, (2018).
DOI:10.1016/j.commatsci.2018.08.029
Install aimsgb
==============
1. Clone the latest version from github::
git clone git@github.com:ksyang2013/aimsgb.git
2. Navigate to aimsgb folder::
cd aimsgb
3. Type in the root of the repo::
pip install .
4. or to install the package in development mode::
pip install -e .
How to cite aimsgb
==================
If you use aimsgb in your research, please consider citing the following work:
Jianli Cheng, Jian Luo, Kesong Yang. *Aimsgb: An algorithm and open-source python
library to generate periodic grain boundary structures.* Computational Materials
Science, 2018, 155, 92-103. `doi:10.1016/j.commatsci.2018.08.029
<https://doi.org/10.1016/j.commatsci.2018.08.029>`_
Copyright
=========
Copyright (C) 2018 The Regents of the University of California
All Rights Reserved. Permission to copy, modify, and distribute this software and its documentation for educational, research and non-profit purposes, without fee, and without a written agreement is hereby granted, provided that the above copyright notice, this paragraph and the following three paragraphs appear in all copies. Permission to make commercial use of this software may be obtained by contacting:
Office of Innovation and Commercialization
9500 Gilman Drive, Mail Code 0910
University of California
La Jolla, CA 92093-0910
(858) 534-5815
innovation@ucsd.edu
This software program and documentation are copyrighted by The Regents of the University of California. The software program and documentation are supplied “as is”, without any accompanying services from The Regents. The Regents does not warrant that the operation of the program will be uninterrupted or error-free. The end-user understands that the program was developed for research purposes and is advised not to rely exclusively on the program for any reason.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN “AS IS” BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
Authors
=======
Dr. Jianli Cheng (jic198@ucsd.edu)
New Email: jianlicheng@lbl.gov
Prof. Kesong Yang (kesong@ucsd.edu)
About the aimsgb Development Team
=================================
http://materials.ucsd.edu/
Raw data
{
"_id": null,
"home_page": "http://aimsgb.org",
"name": "aimsgb",
"maintainer": "Jianli Cheng, Sicong JIANG, and Kesong YANG",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "chengjianli90@gmail.com, sij014@ucsd.edu, kesong@ucsd.edu",
"keywords": "material science,grain boundary,molecular simulation",
"author": "Jianli Cheng and Kesong YANG",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3c/cf/69281d169f689ac740e9db27e1b48cb981a80b9175103b4a5e99278ac12b/aimsgb-1.1.1.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\naimsgb, an efficient and open-source Python library for generating atomic coordinates in periodic grain boundary models. It is designed to\nconstruct various grain boundary structures from cubic and non-cubic initial\nconfigurations. A convenient command line tool has also been provided to enable\neasy and fast construction of tilt and twist boundaries by assigining the degree\nof fit (\u03a3), rotation axis, grain boundary plane and initial crystal structure.\naimsgb is expected to greatly accelerate the theoretical investigation of\ngrain boundary properties and facilitate the experimental analysis of grain\nboundary structures as well.\n\nA reference for the usage of aimsGB software is:\nJianli Cheng, Jian Luo, and Kesong Yang, Aimsgb: An Algorithm and OPen-Source Python Library to Generate Periodic Grain Boundary Structures, Comput. Mater. Sci. 155, 92-103, (2018). \nDOI:10.1016/j.commatsci.2018.08.029 \n\nInstall aimsgb\n==============\n1. Clone the latest version from github::\n\n git clone git@github.com:ksyang2013/aimsgb.git\n\n2. Navigate to aimsgb folder::\n\n cd aimsgb\n\n3. Type in the root of the repo::\n\n pip install .\n\n4. or to install the package in development mode::\n\n pip install -e .\n\n\nHow to cite aimsgb\n==================\n\nIf you use aimsgb in your research, please consider citing the following work:\n\n Jianli Cheng, Jian Luo, Kesong Yang. *Aimsgb: An algorithm and open-source python\n library to generate periodic grain boundary structures.* Computational Materials\n Science, 2018, 155, 92-103. `doi:10.1016/j.commatsci.2018.08.029\n <https://doi.org/10.1016/j.commatsci.2018.08.029>`_\n\n\nCopyright\n=========\nCopyright (C) 2018 The Regents of the University of California\n\nAll Rights Reserved. Permission to copy, modify, and distribute this software and its documentation for educational, research and non-profit purposes, without fee, and without a written agreement is hereby granted, provided that the above copyright notice, this paragraph and the following three paragraphs appear in all copies. Permission to make commercial use of this software may be obtained by contacting:\n\nOffice of Innovation and Commercialization\n9500 Gilman Drive, Mail Code 0910\nUniversity of California\nLa Jolla, CA 92093-0910\n(858) 534-5815\ninnovation@ucsd.edu\n\nThis software program and documentation are copyrighted by The Regents of the University of California. The software program and documentation are supplied \u201cas is\u201d, without any accompanying services from The Regents. The Regents does not warrant that the operation of the program will be uninterrupted or error-free. The end-user understands that the program was developed for research purposes and is advised not to rely exclusively on the program for any reason.\n\nIN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN \u201cAS IS\u201d BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.\n\n\nAuthors\n=======\nDr. Jianli Cheng (jic198@ucsd.edu)\nNew Email: jianlicheng@lbl.gov\n\nProf. Kesong Yang (kesong@ucsd.edu)\n\nAbout the aimsgb Development Team\n=================================\nhttp://materials.ucsd.edu/\n",
"bugtrack_url": null,
"license": "",
"summary": "aimsgb is a python library for generatng the atomic coordinates of periodic grain boundaries.Copyright \u00a9 2018 The Regents of the University of California.All Rights Reserved. See more in Copyright.",
"version": "1.1.1",
"project_urls": {
"Homepage": "http://aimsgb.org"
},
"split_keywords": [
"material science",
"grain boundary",
"molecular simulation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4661152126d2c7c9ea74544882dcffc29ae78794b23dbc3ba453076bb6d1aae",
"md5": "5df974375e5a604c8ff394840c6d0310",
"sha256": "f4e44fd1555bb10ec65309f63892e2d8ac3c9a5b171340594f1aa3c9d025bee5"
},
"downloads": -1,
"filename": "aimsgb-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5df974375e5a604c8ff394840c6d0310",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 19331,
"upload_time": "2024-03-15T04:27:04",
"upload_time_iso_8601": "2024-03-15T04:27:04.339782Z",
"url": "https://files.pythonhosted.org/packages/f4/66/1152126d2c7c9ea74544882dcffc29ae78794b23dbc3ba453076bb6d1aae/aimsgb-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ccf69281d169f689ac740e9db27e1b48cb981a80b9175103b4a5e99278ac12b",
"md5": "64049c98cabab3d38b84161bfb30108e",
"sha256": "4fc39da404a988d0e2fa34e0222570279a9607fe85b16ede2012c215bcc4c075"
},
"downloads": -1,
"filename": "aimsgb-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "64049c98cabab3d38b84161bfb30108e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19111,
"upload_time": "2024-03-15T04:27:06",
"upload_time_iso_8601": "2024-03-15T04:27:06.162599Z",
"url": "https://files.pythonhosted.org/packages/3c/cf/69281d169f689ac740e9db27e1b48cb981a80b9175103b4a5e99278ac12b/aimsgb-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 04:27:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "aimsgb"
}
