AtomMan
=======
Atomistic Manipulation Toolkit
AtomMan: the Atomistic Manipulation Toolkit is a Python library for
creating, representing, manipulating, and analyzing large-scale atomic
systems of atoms. The focus of the package is to facilitate the rapid design
and development of simulations that are fully documented and easily adaptable
to new potentials, configurations, etc. The code has no requirements that
limit which systems it can be used on, i.e. it should work on Linux, Mac and
Windows computers.
Features:
1. Allows for efficient and fast calculations on millions of atoms, each with
many freely defined per-atom properties.
2. Built-in tools for generating and analyzing crystalline defects, such as
point defects, stacking faults, and dislocations.
4. Call LAMMPS directly from Python and instantly retrieve the resulting data
or LAMMPS error statement.
5. Easily convert systems to/from the other Python atomic representations, such
as ase.Atoms and pymatgen.Structure.
6. Can read and dump crystal structure information from a number of formats,
such as LAMMPS data and dump files, and POSCAR.
7. Built-in unit conversions.
Installation
------------
The atomman package is compatible with Python 3.7+.
The latest release can be installed using pip::
pip install atomman
or using conda from the conda-forge channel::
conda install -c conda-forge atomman
For Windows users, it is recommended to use an Anaconda distribution and use
conda to install numpy, scipy, matplotlib, pandas and cython prior to
installing atomman.
Alternatively, all code and documentation can be downloaded from GitHub.
- The stable releases are available at
`https://github.com/usnistgov/atomman <https://github.com/usnistgov/atomman>`__.
- The working development versions are at
`https://github.com/lmhale99/atomman <https://github.com/lmhale99/atomman>`__.
Documentation
-------------
Web-based documentation for the atomman package is available at
`https://www.ctcms.nist.gov/potentials/atomman <https://www.ctcms.nist.gov/potentials/atomman>`__.
Source code for the documentation can be found in the
`github doc directory <https://github.com/usnistgov/atomman/tree/master/doc/>`__.
The doc directory contains the information both as the source RestructuredText
files and as unformatted HTML. If you download a copy, you can view the HTML
version offline by
cd {atomman_path}/doc/html
python -m http.server
Then, opening localhost:8000 in a web browser.
The documentation consists of two main components:
1. **Tutorial Jupyter Notebooks:**
`Online html version <https://www.ctcms.nist.gov/potentials/atomman/tutorial/index.html>`__,
`Downloadable Notebook version <https://github.com/usnistgov/atomman/tree/master/doc/tutorial>`__.
The tutorials starting with ##. provide a general overview/example of the
various capabilities. The tutorials starting with ##.#. give more detailed
descriptions and list options available to the tools mentioned in the
overview tutorials.
2. **Code Documentation:**
`Online html version <https://www.ctcms.nist.gov/potentials/atomman/atomman.html>`__.
This provides a rendering of the Python docstrings for the included
functions and classes.
Optional packages
-----------------
This is a list of additional Python packages that are needed for some of the
optional features of the package.
- `diffpy.Structure <http://www.diffpy.org/diffpy.Structure/>`__:
CIF reader. Required for loading systems from CIF files.
- `ase <https://wiki.fysik.dtu.dk/ase/>`__:
The Atomic Simulation Environment for interacting with small systems
and DFT calculations. Required for converting to/from ase.Atoms objects.
- `pymatgen <http://pymatgen.org/>`__:
The Python Materials Genomics package used by the Materials
Project for DFT calculations. Required for converting to/from
pymatgen.Structure objects.
- `spglib <https://atztogo.github.io/spglib/python-spglib.html>`__:
A Python interface to the spglib spacegroup analysis code. spglib
can be used to analyze and determine the spacegroup for an atomic system.
Required for converting to/from spglib.cell objects.
Raw data
{
"_id": null,
"home_page": "https://github.com/usnistgov/atomman/",
"name": "atomman",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "atom, atomic, atomistic, molecular dynamics",
"author": "Lucas Hale",
"author_email": "lucas.hale@nist.gov",
"download_url": "https://files.pythonhosted.org/packages/c1/88/9cc87262716d850ff200041b62d8b82f37961c3c7c08778f816477d4dc12/atomman-1.4.11.tar.gz",
"platform": null,
"description": "AtomMan\r\n=======\r\n\r\nAtomistic Manipulation Toolkit\r\n\r\nAtomMan: the Atomistic Manipulation Toolkit is a Python library for\r\ncreating, representing, manipulating, and analyzing large-scale atomic\r\nsystems of atoms. The focus of the package is to facilitate the rapid design\r\nand development of simulations that are fully documented and easily adaptable\r\nto new potentials, configurations, etc. The code has no requirements that\r\nlimit which systems it can be used on, i.e. it should work on Linux, Mac and\r\nWindows computers.\r\n\r\nFeatures:\r\n\r\n1. Allows for efficient and fast calculations on millions of atoms, each with\r\n many freely defined per-atom properties.\r\n\r\n2. Built-in tools for generating and analyzing crystalline defects, such as\r\n point defects, stacking faults, and dislocations.\r\n\r\n4. Call LAMMPS directly from Python and instantly retrieve the resulting data\r\n or LAMMPS error statement.\r\n\r\n5. Easily convert systems to/from the other Python atomic representations, such\r\n as ase.Atoms and pymatgen.Structure.\r\n\r\n6. Can read and dump crystal structure information from a number of formats,\r\n such as LAMMPS data and dump files, and POSCAR.\r\n\r\n7. Built-in unit conversions.\r\n\r\nInstallation\r\n------------\r\n\r\nThe atomman package is compatible with Python 3.7+.\r\n\r\nThe latest release can be installed using pip::\r\n\r\n pip install atomman\r\n\r\nor using conda from the conda-forge channel::\r\n\r\n conda install -c conda-forge atomman\r\n\r\nFor Windows users, it is recommended to use an Anaconda distribution and use\r\nconda to install numpy, scipy, matplotlib, pandas and cython prior to\r\ninstalling atomman.\r\n\r\nAlternatively, all code and documentation can be downloaded from GitHub.\r\n\r\n- The stable releases are available at\r\n `https://github.com/usnistgov/atomman <https://github.com/usnistgov/atomman>`__.\r\n\r\n- The working development versions are at\r\n `https://github.com/lmhale99/atomman <https://github.com/lmhale99/atomman>`__.\r\n \r\nDocumentation\r\n-------------\r\n\r\nWeb-based documentation for the atomman package is available at\r\n`https://www.ctcms.nist.gov/potentials/atomman <https://www.ctcms.nist.gov/potentials/atomman>`__.\r\n\r\nSource code for the documentation can be found in the\r\n`github doc directory <https://github.com/usnistgov/atomman/tree/master/doc/>`__.\r\nThe doc directory contains the information both as the source RestructuredText\r\nfiles and as unformatted HTML. If you download a copy, you can view the HTML\r\nversion offline by\r\n\r\n cd {atomman_path}/doc/html\r\n python -m http.server\r\n\r\nThen, opening localhost:8000 in a web browser.\r\n\r\nThe documentation consists of two main components:\r\n\r\n1. **Tutorial Jupyter Notebooks:**\r\n `Online html version <https://www.ctcms.nist.gov/potentials/atomman/tutorial/index.html>`__,\r\n `Downloadable Notebook version <https://github.com/usnistgov/atomman/tree/master/doc/tutorial>`__.\r\n The tutorials starting with ##. provide a general overview/example of the\r\n various capabilities. The tutorials starting with ##.#. give more detailed\r\n descriptions and list options available to the tools mentioned in the\r\n overview tutorials.\r\n\r\n2. **Code Documentation:**\r\n `Online html version <https://www.ctcms.nist.gov/potentials/atomman/atomman.html>`__.\r\n This provides a rendering of the Python docstrings for the included\r\n functions and classes.\r\n\r\n\r\nOptional packages\r\n-----------------\r\n\r\nThis is a list of additional Python packages that are needed for some of the\r\noptional features of the package.\r\n\r\n- `diffpy.Structure <http://www.diffpy.org/diffpy.Structure/>`__:\r\n CIF reader. Required for loading systems from CIF files.\r\n\r\n- `ase <https://wiki.fysik.dtu.dk/ase/>`__:\r\n The Atomic Simulation Environment for interacting with small systems\r\n and DFT calculations. Required for converting to/from ase.Atoms objects.\r\n\r\n- `pymatgen <http://pymatgen.org/>`__:\r\n The Python Materials Genomics package used by the Materials\r\n Project for DFT calculations. Required for converting to/from\r\n pymatgen.Structure objects.\r\n\r\n- `spglib <https://atztogo.github.io/spglib/python-spglib.html>`__:\r\n A Python interface to the spglib spacegroup analysis code. spglib\r\n can be used to analyze and determine the spacegroup for an atomic system.\r\n Required for converting to/from spglib.cell objects.\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Atomistic Manipulation Toolkit",
"version": "1.4.11",
"project_urls": {
"Homepage": "https://github.com/usnistgov/atomman/"
},
"split_keywords": [
"atom",
" atomic",
" atomistic",
" molecular dynamics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9e855ecf1349d1afc20a80036e4803b0c2d24cbd3cbe8240bc3bf2dfe7bbf223",
"md5": "8928969f5c1f4c4ada08709dafd410e4",
"sha256": "95e59c8320b09f578c80bb932d0c26447603862b9258853a719b1abd25759ada"
},
"downloads": -1,
"filename": "atomman-1.4.11-cp310-cp310-win_amd64.whl",
"has_sig": false,
"md5_digest": "8928969f5c1f4c4ada08709dafd410e4",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": null,
"size": 2232073,
"upload_time": "2024-04-30T17:45:16",
"upload_time_iso_8601": "2024-04-30T17:45:16.749996Z",
"url": "https://files.pythonhosted.org/packages/9e/85/5ecf1349d1afc20a80036e4803b0c2d24cbd3cbe8240bc3bf2dfe7bbf223/atomman-1.4.11-cp310-cp310-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2043869ca28dc88441470fbb65df2314e57ffe5f818a2cc6a4dfd84ad6eb37c",
"md5": "d5b7ee447ddf136bee7a8f4b20ba0ca5",
"sha256": "c6a31689f42b243d56daf926d4ccbec6e90b29ff7c762d9dfef4b01c51fb64f4"
},
"downloads": -1,
"filename": "atomman-1.4.11-cp311-cp311-win_amd64.whl",
"has_sig": false,
"md5_digest": "d5b7ee447ddf136bee7a8f4b20ba0ca5",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": null,
"size": 2231955,
"upload_time": "2024-04-30T17:45:24",
"upload_time_iso_8601": "2024-04-30T17:45:24.376408Z",
"url": "https://files.pythonhosted.org/packages/d2/04/3869ca28dc88441470fbb65df2314e57ffe5f818a2cc6a4dfd84ad6eb37c/atomman-1.4.11-cp311-cp311-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "531106af0e07b5fa30f65f1f691a037e5d74cf4e36045ee6d3542ae2f9cd2cf1",
"md5": "ec1387bba5abbd29a7de7454b28632da",
"sha256": "6455842b0f9e2dcbc920533ea1d1e6c5350a6e4f834f593a1815b27876c73a82"
},
"downloads": -1,
"filename": "atomman-1.4.11-cp38-cp38-win_amd64.whl",
"has_sig": false,
"md5_digest": "ec1387bba5abbd29a7de7454b28632da",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": null,
"size": 2235797,
"upload_time": "2024-04-30T17:45:28",
"upload_time_iso_8601": "2024-04-30T17:45:28.714650Z",
"url": "https://files.pythonhosted.org/packages/53/11/06af0e07b5fa30f65f1f691a037e5d74cf4e36045ee6d3542ae2f9cd2cf1/atomman-1.4.11-cp38-cp38-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24ecef5e78f60ed3e002868206338093f5086ddf4854457c712953c05da821b8",
"md5": "d9227bd9e146aca79a29ac3844e58d84",
"sha256": "bdfe795eb2750dba7b37efe0429f69e6241227a545f54891926a145da4915271"
},
"downloads": -1,
"filename": "atomman-1.4.11-cp39-cp39-win_amd64.whl",
"has_sig": false,
"md5_digest": "d9227bd9e146aca79a29ac3844e58d84",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": null,
"size": 2233972,
"upload_time": "2024-04-30T17:45:33",
"upload_time_iso_8601": "2024-04-30T17:45:33.051203Z",
"url": "https://files.pythonhosted.org/packages/24/ec/ef5e78f60ed3e002868206338093f5086ddf4854457c712953c05da821b8/atomman-1.4.11-cp39-cp39-win_amd64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1889cc87262716d850ff200041b62d8b82f37961c3c7c08778f816477d4dc12",
"md5": "a3a9d5d9abd858e1bcf958c42b58bfb5",
"sha256": "9c0124e59e0fa7330343b2ca9cdae1138052702b3a17cf36d61e5ff020ee10c4"
},
"downloads": -1,
"filename": "atomman-1.4.11.tar.gz",
"has_sig": false,
"md5_digest": "a3a9d5d9abd858e1bcf958c42b58bfb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1907566,
"upload_time": "2024-04-30T17:45:36",
"upload_time_iso_8601": "2024-04-30T17:45:36.015545Z",
"url": "https://files.pythonhosted.org/packages/c1/88/9cc87262716d850ff200041b62d8b82f37961c3c7c08778f816477d4dc12/atomman-1.4.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-30 17:45:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "usnistgov",
"github_project": "atomman",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "atomman"
}
JSON
