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://travis-ci.org/usnistgov/jarvis.svg?branch=master 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
  • A summary of the projects

    Projects

    Brief description

    JARVIS-DFT

    Density functional theory calculation database for ~40000 3D and ~1000 2D materials. Some of the material-properties include: Heat of formation, Crystal-structural data using OptB88vdW, PBE, LDA functionals, Bandgaps using semi-local, meta-GGA, HSE06 and other beyond DFT methods, Electron and phonon-bandstructures, Elastic, Piezoelectric, Thermoelectric, Dielectric tensors, Exfoliation energies for low-diemnsional materials, Frequency dependent dielectric function, Absorption coefficients, Work-function for 2D materials, Infrared and Raman intensities, Electric field gradient, Magnetic moment, Solar-cell efficiencies, Scanning Tunneling Microscopy (STM) images, Topological spin-orbit spillage, converged k-point and plane wave cut-offs, Wannier-tight binding Hamiltonian parameters and more. The website for JARVIS-DFT: https://www.ctcms.nist.gov/~knc6/JVASP.html

    JARVIS-FF

    Classical molecular dynamics calculation database for ~2000 3D materials with interatomic potential/force-fields. Some of the properties included in JARVIS-FF are energetics, elastic constants, surface energies, defect formations energies and phonon frequencies of materials. The website for JARVIS-FF: https://www.ctcms.nist.gov/~knc6/periodic.html

    JARVIS-ML

    Machine learning prediction tools trained on the JARVIS-DFT data. Some of the ML-prediction models are for Heat of formation, GGA/METAGGA bandgaps, Refractive indices, Bulk and shear modulus, Magnetic moment, Thermoelectric, Piezoelectric and Dielectric properties properties, Exfoliation energies, Solar-cell efficiency, and STM image classification. The website for JARVIS-ML: https://www.ctcms.nist.gov/jarvisml/

    JARVIS-Het.

    Heterostructure design tools for 2D materials in the JARVIS-DFT database. Some of the properties available are: work function, Band-alignment, and Heterostructure classification. JARVIS-Heterostructure website: https://www.ctcms.nist.gov/jarvish/

    JARVIS-PV

    Solar-cell/Photovoltaic cell design tools. Dataset is made available and the website will be available soon.

    JARVIS-STM

    Scanning-tunneling microscopy images for 2D materials. Dataset is made available and the website will be available soon.

    JARVIS-WTB

    Wannier Tight Binding Hamiltonian parameter dataset. Website: https://www.ctcms.nist.gov/jarviswtb .

    JARVIS-EFG

    Electric field gradient dataset. Dataset will be made available and the website will be available soon.

    Downloads

    Download raw metadat at: https://www.ctcms.nist.gov/~knc6/downloads.html

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

References

Please see Publications related to JARVIS-Tools

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.7.8.tar.gz (730.1 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.7.8-py2.py3-none-any.whl (792.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for jarvis-tools-2020.7.8.tar.gz
Algorithm Hash digest
SHA256 0daffadf1948655544bb5df390a570cb17839bb1e7265e81916eebe6b7defc02
MD5 0152d75e4546eb11bb55a4adc0bf2798
BLAKE2b-256 83cf4f141d967002c4c2f6537fdda7c2e3f2a53bb2e97370427c6ae9b8f38bca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jarvis_tools-2020.7.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 792.4 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/39.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.2

File hashes

Hashes for jarvis_tools-2020.7.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 82a5c097f16a9578e6dc37c5a7541320f2ed0c6f486a5c78497dbb701276ba46
MD5 481e762606d85c0ed3a1ed073d28314e
BLAKE2b-256 50d9665b34daaf2f8454497c940b01f202950f132c4c38063fa0532005ca7a7b

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