Skip to main content

High throughput computation with density functional theory, molecular dynamics and machine learning. 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://api.codacy.com/project/badge/Grade/be8fa78b1c0a49c280415ce061163e77 https://img.shields.io/pypi/dm/jarvis-tools.svg https://pepy.tech/badge/jarvis-tools https://codecov.io/gh/knc6/jarvis/branch/master/graph/badge.svg

JARVIS

Joint Automated Repository for Various Integrated Simulations (JARVIS) is an integrated framework for computational science using density functional theory, classical force-field/molecular dynamics and machine-learning. The jarvis-tools package can be used for high-throughput computation, data-analysis, and training machine-learning models. Some of the packages used in the jarvis-tools package are shown below. JARVIS-official website: https://jarvis.nist.gov

https://github.com/knc6/jarvis/blob/master/jarvis/tools/jarvis-git.JPG https://github.com/knc6/jarvis/blob/master/jarvis/colab/colab_figures/statistics.JPG

Installing JARVIS

  • We recommend installing miniconda environment from https://conda.io/miniconda.html

    bash Miniconda3-latest-Linux-x86_64.sh (for linux)
    bash Miniconda3-latest-MacOSX-x86_64.sh (for Mac)
    Download 32/64 bit python 3.6 miniconda exe and install (for windows)
    Now, let's make a conda environment just for JARVIS::
    conda create --name my_jarvis python=3.6
    source activate my_jarvis
    
  • Git clone install (Recommended):

    pip install numpy scipy matplotlib
    git clone https://github.com/usnistgov/jarvis.git
    cd jarvis
    python setup.py install
    
  • Alternative pip install:

    pip install numpy scipy matplotlib
    pip install jarvis-tools
    
  • Alternative nix install:: Nix allows a robust and reproducible package for Linux. To generate a Nix environment for using JARVIS, follow the Nix instructions.

Jupyter notebooks

  • Python for beginners:
https://github.com/knc6/jarvis/blob/master/jarvis/colab/colab_figures/novice.JPG
  • JARVIS-DFT data analysis:
https://github.com/knc6/jarvis/blob/master/jarvis/colab/colab_figures/jdft.JPG
  • JARVIS-ML training:
https://github.com/knc6/jarvis/blob/master/jarvis/colab/colab_figures/jml_train.JPG
  • Comparing ML algorithms:
https://github.com/knc6/jarvis/blob/master/jarvis/colab/colab_figures/compareml.JPG
  • JARVIS-FF data-analysis:
https://github.com/knc6/jarvis/blob/master/jarvis/colab/colab_figures/jff.JPG
  • See more in the plot-gallery below

References

  • JARVIS-FF:
    1. Evaluation and comparison of classical interatomic potentials through a user-friendly interactive web-interface, Nature: Sci Data. 4, 160125 (2017).https://www.nature.com/articles/sdata2016125
    2. High-throughput assessment of vacancy formation and surface energies of materials using classical force-fields, J. Phys. Cond. Matt. 30, 395901(2018).http://iopscience.iop.org/article/10.1088/1361-648X/aadaff/meta
  • JARVIS-DFT:
    1. High-throughput Identification and Characterization of Two-dimensional Materials using Density functional theory, Scientific Reports 7, 5179 (2017).https://www.nature.com/articles/s41598-017-05402-0
    2. Computational Screening of High-performance Optoelectronic Materials using OptB88vdW and TBmBJ Formalisms, Scientific Data 5, 180082 (2018).https://www.nature.com/articles/sdata201882
    3. Elastic properties of bulk and low-dimensional materials using van der Waals density functional, Phys. Rev. B, 98, 014107 (2018).https://journals.aps.org/prb/abstract/10.1103/PhysRevB.98.014107
    4. Convergence and machine learning predictions of Monkhorst-Pack k-points and plane-wave cut-off in high-throughput DFT calculations, Comp. Mat. Sci. 161, 300 (2019).https://www.sciencedirect.com/science/article/pii/S0927025619300813?via%3Dihub
    5. High-throughput Discovery of Topologically Non-trivial Materials using Spin-orbit Spillage, Nature: Sci. Rep. 9, 8534,(2019), https://www.nature.com/articles/s41598-019-45028-y
    6. Accelerated Discovery of Efficient Solar-cell Materials using Quantum and Machine-learning Methods, Chem. Mater., https://pubs.acs.org/doi/10.1021/acs.chemmater.9b02166
    7. Data-driven Discovery of 3D and 2D Thermoelectric Materials , https://arxiv.org/abs/1903.06651.
  • JARVIS-ML:
    1. Machine learning with force-field inspired descriptors for materials: fast screening and mapping energy landscape, Phys. Rev. Mat., 2, 083801 (2018).,https://journals.aps.org/prmaterials/abstract/10.1103/PhysRevMaterials.2.083801
    2. Materials science in the artificial intelligence age: high-throughput library generation, machine learning, and a pathway from correlations to the underpinning physics, MRS Comm., 1-18 https://doi.org/10.1557/mrc.2019.95

Running the examples

Founders

Kamal Choudhary, Francesca Tavazza (NIST)

Contributors

Daniel Wheeler, Faical Yannick Congo, Kevin Garrity, Brian DeCost, Adam Biacchi, Lucas Hale, Andrew Reid, Marcus Newrock (NIST)

Project details


Download files

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

Files for jarvis-tools, version 2019.7.31
Filename, size File type Python version Upload date Hashes
Filename, size jarvis_tools-2019.7.31-py2.py3-none-any.whl (727.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size jarvis-tools-2019.7.31.tar.gz (688.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page