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, 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

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.22.tar.gz (740.2 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.22-py2.py3-none-any.whl (807.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: jarvis-tools-2020.7.22.tar.gz
  • Upload date:
  • Size: 740.2 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.22.tar.gz
Algorithm Hash digest
SHA256 af9754839f292eef839b27e3ecf2c7a0a44feaf40f879fef934549bbab0edf5b
MD5 0e83298aa73b14dedb474b13137b3d30
BLAKE2b-256 eb0d9c2b00814f581bd9fcbe7f9fd27282f6be4082522af0af678c9cc15bad21

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jarvis_tools-2020.7.22-py2.py3-none-any.whl
  • Upload date:
  • Size: 807.8 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.22-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0e5324a605d3e6c3c2ab83ac340f176f5adf3548cbe487990bb6b39c83d2cc36
MD5 96b8120d86ef06749fe4979c129fa7ba
BLAKE2b-256 14a4576707b5a2a83dcbdabf0e7863fc1350242e6b8052c32947b1676687f3e6

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