Skip to main content

jarvis-tools: an open-source software package for data-driven atomistic materials design. https://jarvis.nist.gov/

Project description

https://circleci.com/gh/usnistgov/jarvis.svg?style=shield https://img.shields.io/travis/usnistgov/jarvis/master.svg?label=Travis%20CI https://ci.appveyor.com/api/projects/status/d8na8vyfm7ulya9p/branch/master?svg=true https://github.com/usnistgov/jarvis/workflows/JARVIS-Tools%20github%20action/badge.svg https://github.com/usnistgov/jarvis/workflows/JARVIS-Tools%20linting/badge.svg https://readthedocs.org/projects/jarvis-tools/badge/?version=latest https://img.shields.io/codecov/c/github/knc6/jarvis https://img.shields.io/pypi/dm/jarvis-tools.svg https://pepy.tech/badge/jarvis-tools https://zenodo.org/badge/DOI/10.5281/zenodo.3903515.svg https://img.shields.io/github/v/tag/usnistgov/jarvis https://app.codacy.com/project/badge/Grade/be8fa78b1c0a49c280415ce061163e77 https://img.shields.io/github/commit-activity/y/usnistgov/jarvis https://img.shields.io/github/repo-size/usnistgov/jarvis https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fjarvisnist https://img.shields.io/badge/Facebook-Follow-Blue.svg https://img.shields.io/badge/LinkedIn-Follow-Blue.svg

JARVIS-Tools: an open-source software package for data-driven atomistic materials design

NIST-JARVIS (Joint Automated Repository for Various Integrated Simulations) is an integrated framework for computational science using density functional theory, classical force-field/molecular dynamics and machine-learning. The jarvis-tools package consists of scripts used in generating and analyzing the dataset. The NIST-JARVIS official website is: https://jarvis.nist.gov . This project is a part of the Materials Genome Initiative (MGI) at NIST (https://mgi.nist.gov/).

For more details, checkout our latest article: JARVIS: An Integrated Infrastructure for Data-driven Materials Design

https://www.ctcms.nist.gov/~knc6/images/logo/jarvis-mission.png

Some important features

  • Software workflow tasks: VASP, Quantum Espresso, Wien2k BoltzTrap, Wannier90, LAMMPS, Scikit-learn, TensorFlow, LightGBM.

  • HPC clusters: PBS and SLURM.

  • Examples: Notebooks and test scripts to explain the package.

  • Available datasets: Summary of several datasets .

Installation

Please see Installation instructions

Example Jupyter notebooks

Please find several Google Colab Notebooks

Example function

>>> from jarvis.core.atoms import Atoms
>>> box = [[2.715, 2.715, 0], [0, 2.715, 2.715], [2.715, 0, 2.715]]
>>> coords = [[0, 0, 0], [0.25, 0.25, 0.25]]
>>> elements = ["Si", "Si"]
>>> Si = Atoms(lattice_mat=box, coords=coords, elements=elements)
>>> density = round(Si.density,2)
>>> print (density)
2.33
>>>
>>> from jarvis.db.figshare import data
>>> dft_3d = data(dataset='dft_3d')
>>> print (len(dft_3d))
36099
>>> from jarvis.io.vasp.inputs import Poscar
>>> for i in dft_3d:
...     atoms = Atoms.from_dict(i['atoms'])
...     poscar = Poscar(atoms)
...     jid = i['jid']
...     filename = 'POSCAR-'+jid+'.vasp'
...     poscar.write_file(filename)
>>> dft_2d = data(dataset='dft_2d')
>>> print (len(dft_2d))
1070
>>> for i in dft_2d:
...     atoms = Atoms.from_dict(i['atoms'])
...     poscar = Poscar(atoms)
...     jid = i['jid']
...     filename = 'POSCAR-'+jid+'.vasp'
...     poscar.write_file(filename)

References

Please see Publications related to JARVIS-Tools

Documentation

https://jarvis-materials-design.github.io/dbdocs/

Correspondence

Please report bugs as Github issues (https://github.com/usnistgov/jarvis/issues) or email to kamal.choudhary@nist.gov.

Funding support

NIST-MGI (https://www.nist.gov/mgi).

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jarvis-tools-2020.10.10.tar.gz (799.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jarvis_tools-2020.10.10-py2.py3-none-any.whl (873.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file jarvis-tools-2020.10.10.tar.gz.

File metadata

  • Download URL: jarvis-tools-2020.10.10.tar.gz
  • Upload date:
  • Size: 799.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0.post20200209 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.11

File hashes

Hashes for jarvis-tools-2020.10.10.tar.gz
Algorithm Hash digest
SHA256 b4cc45267100fe2cc4d114d1453ad39e87d35244ce511c44b1fc99ca277f8a07
MD5 ca28af101e97be378952606a5e47bc54
BLAKE2b-256 15fa30d5c9ca4b8ab88c6c77ac6345c8e2a7a3886501ce37decac2f2ebe05ec6

See more details on using hashes here.

File details

Details for the file jarvis_tools-2020.10.10-py2.py3-none-any.whl.

File metadata

  • Download URL: jarvis_tools-2020.10.10-py2.py3-none-any.whl
  • Upload date:
  • Size: 873.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0.post20200209 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.11

File hashes

Hashes for jarvis_tools-2020.10.10-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b9d6f0f383815bdf7d6d2d134d0df987b1fcb882c8e8c99891cd3043827df0d3
MD5 1cf6437e22f34c1b9a90e832c19be07a
BLAKE2b-256 2d458eada791530f3f7fd61e57f10a36b6c98efd7828707419837122a14e5e7f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page