Skip to content

Commit 3328ed8

Browse files
knc6tavazzaknc6KAMAL CHOUDHARYwines1
authored
Develop (#293)
* Fix CHGCAR vasp. * Added volumetric reshape for CHGCAR. * Tmp * Tershoff Hamman update, specie update. * Add crop from center in STM. * Add Fourier transfor in STM. * Update STM pytest. * Add DPI to STM. * Zeo++ added, Atoms cif update, STM update, random vacancy maker added. * Atoms tempfile fix, Potcar from atoms module added. * Test for docs. * C2DB link update, docs Atoms update. * C2DB link update, docs Atoms update. * Version update, COD DB, QM9 JCTC DB added. * Compostion bug fix, elemental descriptor added. * Develop (#186) * Update outputs.py I added the calculation of the Raman intensities inside parse_raman_dat * Update outputs.py * Update outputs.py * Update outputs.py * Update cfid.py * Delete __init__.py * stylecss added. * stylecss added. * Adding extra Makefile/ * Remove examples from docs. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Tutorials update. * Tutorials docs update. * Docs update,pdb reader updated. * Update action_build.yml * Update action_build.yml * Remove pytraj strong dependencies. * Update docs, Added PDBBind and HPOV datasets. * Docs update. * Add thcikness to surface builder. * Surface builder update, Chemical only magpie descriptors added, pdb_core dataset added, zeopp tempfile bugfix. * Typo fix. * Add names to chem descs. * Lessen hermsolver pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * No DFT3D * Exclude dft_3d dataset for memory issue. * Update figshare test. * Update figshare test. * Exclude db from coverage. * Exclude db from coverage. * Add magpie.json. * Add magpie.json. * Wien2k bands bug fix. * Wien2k bands bug fix. * Update JARVIS-FF,Elastictensor,LAMMPS parse folder, VASP bandstructure plot code. * JFF update. * Add JQE_TB3 and hMOF dataset. * Update LAMMPS module. * Update LAMMPS module. * Fix elastic tensor module. * Figshare update, docs db name update. * Substitutions. * Update figshare dft_3d, cfid_3d. * Docs data update. * Generate substitutions. * Lint fix. * Update DOS. * Update DOS. * Adding folders for nexus setup. * Update QMOF and hMOF info. * Fixing auto klength error. * Adding zeopp surface area. * Vacancy bug fix, added hmof to docs. * vacancy update. * QE inputs update. * Pyhon 3.9 test, added QE el-ph, VASP XANES, modified hmof db details. * Update Contribution.rst * Minor lint fix. * Update action_build.yml * Update action_build.yml * Fix qiskit requirements. * Fix phonopy requirements. * Fix all requirements. * Fix phonopy requirements. * QE test. * QE test. * Update action_build. * Try other python versions. * Try other python versions. * README updates. * Adding nexus. (#197) * Develop (#196) * Image augmentation. * Augment images. * Augment images. * Specie update. * Add Latt2D, STM image (b-1) fix, image augmentation fix. * Add Latt2D, STM image (b-1) fix, image augmentation fix. * Update conf.py * Update conf.py * Multi-output graph bacthing. * Add EDOS dataset. * Temp. * Add circuit maker. * Add circuit maker. * NELECT update. * Version update, more DBs added. * Fix CHGCAR vasp. * Added volumetric reshape for CHGCAR. * Tmp * Tershoff Hamman update, specie update. * Add crop from center in STM. * Add Fourier transfor in STM. * Update STM pytest. * Add DPI to STM. * Zeo++ added, Atoms cif update, STM update, random vacancy maker added. * Atoms tempfile fix, Potcar from atoms module added. * Test for docs. * C2DB link update, docs Atoms update. * C2DB link update, docs Atoms update. * Version update, COD DB, QM9 JCTC DB added. * Compostion bug fix, elemental descriptor added. * Develop (#186) * Update outputs.py I added the calculation of the Raman intensities inside parse_raman_dat * Update outputs.py * Update outputs.py * Update outputs.py * Update cfid.py * Delete __init__.py * stylecss added. * stylecss added. * Adding extra Makefile/ * Remove examples from docs. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Tutorials update. * Tutorials docs update. * Docs update,pdb reader updated. * Update action_build.yml * Update action_build.yml * Remove pytraj strong dependencies. * Update docs, Added PDBBind and HPOV datasets. * Docs update. * Add thcikness to surface builder. * Surface builder update, Chemical only magpie descriptors added, pdb_core dataset added, zeopp tempfile bugfix. * Typo fix. * Add names to chem descs. * Lessen hermsolver pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * No DFT3D * Exclude dft_3d dataset for memory issue. * Update figshare test. * Update figshare test. * Exclude db from coverage. * Exclude db from coverage. * Add magpie.json. * Add magpie.json. * Wien2k bands bug fix. * Wien2k bands bug fix. * Update JARVIS-FF,Elastictensor,LAMMPS parse folder, VASP bandstructure plot code. * JFF update. * Add JQE_TB3 and hMOF dataset. * Update LAMMPS module. * Update LAMMPS module. * Fix elastic tensor module. * Figshare update, docs db name update. * Substitutions. * Update figshare dft_3d, cfid_3d. * Docs data update. * Generate substitutions. * Lint fix. * Update DOS. * Update DOS. Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> * First input. * added black * Example folder. Co-authored-by: Kamal Choudhary <writetokamal.1989@gmail.com> Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> * Revert back. * Update .readthedocs.yaml * Update dev-requirements.txt * Docs requirements update. * Update .readthedocs.yaml * Update requirements.txt * Update .readthedocs.yaml * Update requirements.txt * Update .readthedocs.yaml * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update atoms.py * Fixe pbc in ase_to_Atoms. * Add installation tests (#214) * QE inputs, XANES, GHAction updates. (#210) * Image augmentation. * Augment images. * Augment images. * Specie update. * Add Latt2D, STM image (b-1) fix, image augmentation fix. * Add Latt2D, STM image (b-1) fix, image augmentation fix. * Update conf.py * Update conf.py * Multi-output graph bacthing. * Add EDOS dataset. * Temp. * Add circuit maker. * Add circuit maker. * NELECT update. * Version update, more DBs added. * Fix CHGCAR vasp. * Added volumetric reshape for CHGCAR. * Tmp * Tershoff Hamman update, specie update. * Add crop from center in STM. * Add Fourier transfor in STM. * Update STM pytest. * Add DPI to STM. * Zeo++ added, Atoms cif update, STM update, random vacancy maker added. * Atoms tempfile fix, Potcar from atoms module added. * Test for docs. * C2DB link update, docs Atoms update. * C2DB link update, docs Atoms update. * Version update, COD DB, QM9 JCTC DB added. * Compostion bug fix, elemental descriptor added. * Develop (#186) * Update outputs.py I added the calculation of the Raman intensities inside parse_raman_dat * Update outputs.py * Update outputs.py * Update outputs.py * Update cfid.py * Delete __init__.py * stylecss added. * stylecss added. * Adding extra Makefile/ * Remove examples from docs. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Tutorials update. * Tutorials docs update. * Docs update,pdb reader updated. * Update action_build.yml * Update action_build.yml * Remove pytraj strong dependencies. * Update docs, Added PDBBind and HPOV datasets. * Docs update. * Add thcikness to surface builder. * Surface builder update, Chemical only magpie descriptors added, pdb_core dataset added, zeopp tempfile bugfix. * Typo fix. * Add names to chem descs. * Lessen hermsolver pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * No DFT3D * Exclude dft_3d dataset for memory issue. * Update figshare test. * Update figshare test. * Exclude db from coverage. * Exclude db from coverage. * Add magpie.json. * Add magpie.json. * Wien2k bands bug fix. * Wien2k bands bug fix. * Update JARVIS-FF,Elastictensor,LAMMPS parse folder, VASP bandstructure plot code. * JFF update. * Add JQE_TB3 and hMOF dataset. * Update LAMMPS module. * Update LAMMPS module. * Fix elastic tensor module. * Figshare update, docs db name update. * Substitutions. * Update figshare dft_3d, cfid_3d. * Docs data update. * Generate substitutions. * Lint fix. * Update DOS. * Update DOS. * Adding folders for nexus setup. * Update QMOF and hMOF info. * Fixing auto klength error. * Adding zeopp surface area. * Vacancy bug fix, added hmof to docs. * vacancy update. * QE inputs update. * Pyhon 3.9 test, added QE el-ph, VASP XANES, modified hmof db details. * Update Contribution.rst * Minor lint fix. * Update action_build.yml * Update action_build.yml * Fix qiskit requirements. * Fix phonopy requirements. * Fix all requirements. * Fix phonopy requirements. * QE test. * QE test. * Update action_build. * Try other python versions. * Try other python versions. * README updates. * Adding nexus. (#197) * Develop (#196) * Image augmentation. * Augment images. * Augment images. * Specie update. * Add Latt2D, STM image (b-1) fix, image augmentation fix. * Add Latt2D, STM image (b-1) fix, image augmentation fix. * Update conf.py * Update conf.py * Multi-output graph bacthing. * Add EDOS dataset. * Temp. * Add circuit maker. * Add circuit maker. * NELECT update. * Version update, more DBs added. * Fix CHGCAR vasp. * Added volumetric reshape for CHGCAR. * Tmp * Tershoff Hamman update, specie update. * Add crop from center in STM. * Add Fourier transfor in STM. * Update STM pytest. * Add DPI to STM. * Zeo++ added, Atoms cif update, STM update, random vacancy maker added. * Atoms tempfile fix, Potcar from atoms module added. * Test for docs. * C2DB link update, docs Atoms update. * C2DB link update, docs Atoms update. * Version update, COD DB, QM9 JCTC DB added. * Compostion bug fix, elemental descriptor added. * Develop (#186) * Update outputs.py I added the calculation of the Raman intensities inside parse_raman_dat * Update outputs.py * Update outputs.py * Update outputs.py * Update cfid.py * Delete __init__.py * stylecss added. * stylecss added. * Adding extra Makefile/ * Remove examples from docs. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Docs update. * Tutorials update. * Tutorials docs update. * Docs update,pdb reader updated. * Update action_build.yml * Update action_build.yml * Remove pytraj strong dependencies. * Update docs, Added PDBBind and HPOV datasets. * Docs update. * Add thcikness to surface builder. * Surface builder update, Chemical only magpie descriptors added, pdb_core dataset added, zeopp tempfile bugfix. * Typo fix. * Add names to chem descs. * Lessen hermsolver pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * Reduced pytest. * No DFT3D * Exclude dft_3d dataset for memory issue. * Update figshare test. * Update figshare test. * Exclude db from coverage. * Exclude db from coverage. * Add magpie.json. * Add magpie.json. * Wien2k bands bug fix. * Wien2k bands bug fix. * Update JARVIS-FF,Elastictensor,LAMMPS parse folder, VASP bandstructure plot code. * JFF update. * Add JQE_TB3 and hMOF dataset. * Update LAMMPS module. * Update LAMMPS module. * Fix elastic tensor module. * Figshare update, docs db name update. * Substitutions. * Update figshare dft_3d, cfid_3d. * Docs data update. * Generate substitutions. * Lint fix. * Update DOS. * Update DOS. Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> * First input. * added black * Example folder. Co-authored-by: Kamal Choudhary <writetokamal.1989@gmail.com> Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> * Revert back. * Update .readthedocs.yaml * Update dev-requirements.txt * Docs requirements update. * Update .readthedocs.yaml * Update requirements.txt * Update .readthedocs.yaml * Update requirements.txt * Update .readthedocs.yaml * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update atoms.py * Fixe pbc in ase_to_Atoms. Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> Co-authored-by: wines1 <74620550+wines1@users.noreply.github.com> * Add installation tests * Fix codestyle * Fix codestyle with black * Add docstrings * Fix pydocstyle error * Update __init__.py * Update __init__.py Co-authored-by: Kamal Choudhary <writetokamal.1989@gmail.com> Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> Co-authored-by: wines1 <74620550+wines1@users.noreply.github.com> * Adding QE super. * Minor changes to QE module, atoms xyz fix. * Adding qe_tb info, and version update. * Update __init__.py * WIP super QE. * Working version of ScSi. * QE inputs and task update. * Add master super. * Add master super. * Lint fix. * Lint fix. * Minor fix. * ET update. * Fix ET test. * Update sanitize atoms. * Additonal checks on supercond. * Debye bug fix. * Pressure in QE Super. * Version fix, publication update, supercond workflow update. * Lint fix. * Tensorboard fix. * Tensorboard fix. * Tensorboard fix. * Melting temp fix. * Update vasp.py (#234) * Local tetra tmp. * Version update. * Lint fix. * HSE06 * Tmp. * Vacancy update, Optimade structureand other minor lint updates. * STEM pytest fix. * Minor lint fix. * Fixed selectrive dynamics issue in Poscar, force reading for single atom system in Vasprun, np.array in core.graps, num_atoms for single atom systems in core.Atoms * Lint fix. * Added phononDos class. * fix pytorch UserWarning in build_undirected_edgedata() (#243) site-packages/jarvis/core/graphs.py:158: UserWarning: Creating a tensor from a list of numpy.ndarrays is extremely slow. Please consider converting the list to a single numpy.ndarray with numpy.array() before converting to a tensor. r = torch.tensor(r).type(torch.get_default_dtype()) * Add PhaseDiagram. * Add PhaseDiagram. * PhaseDiagram update. * STM image pytest increase, requirements upgrade. * STM image pytest increase, requirements upgrade. * STM image pytest increase, requirements upgrade. * Compare atoms, get spg info directly from atoms. * Flake8 fix. * Update publications.rst * Update qiskit. * Update qiskit. * Update test_hermsolver.py * FIix qiskit DOS. * Update test_hermsolver.py * Fix linting. * Develop og (#257) * Added isotope scattering rate to phonon DOS analysis script. * Linting fix. * Linting fix. * Linting fix. * Add QE convergence. * Update converg.py. * Nexus. * Super with converg. * Super with converg. * SuperCon QE update. * Figshare DB update. * Figshare DB update. * Update alignn ff link. * Lint fix. * DB docs update. * Minor fixes: delete agg in figshare, add destination path in figshare data, dtype compatibility with new numpy. * Lint fix. * Supercon workflow fix. * Add extra db entires, fix chem in cfid_chem. * Version update. * Add figshare datasets. * Update databases.rst * codecov fix. * Version update. * Lint fix. * Add FigShare datasets, DOS in QE, Uncertainty. * Add python 3.9. * Create README.md * Update README. * Add README.md. * Update action_build.yml * Update action_lint.yml * Allow md file, add mode databases. * Create NISTtheDocs2Death.yml * Allow md file, add mode databases. * Add publications. * Update publications.rst * Update requirements.txt * Update requirements.txt * Update requirements.txt * Update requirements.txt * Create deploy_nist_pages.yml * Add mkdocs. * Update deploy_nist_pages.yml * Update md. * Update setup.py * Update readme. * Update setup.py * Remove absl. * Update dev-requirements.txt * Update index.md * Update deploy_nist_pages.yml --------- Co-authored-by: tavazza <tavazza@gmail.com> Co-authored-by: knc6 <kamal.choudhary@nist.gov> Co-authored-by: KAMAL CHOUDHARY <kamalch@login1.frontera.tacc.utexas.edu> Co-authored-by: wines1 <74620550+wines1@users.noreply.github.com> Co-authored-by: Saurav Maheshkar <sauravvmaheshkar@gmail.com> Co-authored-by: Janosh Riebesell <janosh.riebesell@gmail.com> Co-authored-by: Ramya Gurunathan <ramya1006@gmail.com>
1 parent 7807e8f commit 3328ed8

26 files changed

+2709
-66
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: "Build Documentation"
2+
3+
on: [push, pull_request, delete]
4+
5+
jobs:
6+
docs:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: usnistgov/NISTtheDocs2Death@0.3
10+
with:
11+
docs-folder: docs/
12+
formats: |-
13+
epub
14+
pdf

.github/workflows/action_build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
runs-on: ubuntu-latest
1010
strategy:
1111
matrix:
12-
python-version: [3.8,3.9]
12+
python-version: [3.9]
1313
steps:
1414
- uses: actions/checkout@v2
1515
- name: Setup Python ${{ matrix.python-version }}

.github/workflows/action_lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
strategy:
99
max-parallel: 4
1010
matrix:
11-
python-version: [3.7]
11+
python-version: [3.9]
1212

1313
steps:
1414
- uses: actions/checkout@v1
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
#
2+
# This is a working example of using GitHub Actions to publish the docs
3+
# to the GitHub Pages (gh_pages) branch.
4+
#
5+
# Remember to have a requirements.txt file with the required dependencies.
6+
# This template ships with one by default.
7+
#
8+
# It is also recommendet to also copy the template with all branches, to
9+
# have the gh-pages branch pre-made. This prevents possible errors.
10+
#
11+
name: Deploy Site
12+
13+
# on: [push, pull_request]
14+
15+
on:
16+
push:
17+
branches:
18+
- master
19+
20+
permissions:
21+
contents: write
22+
23+
# on:
24+
# push:
25+
# paths:
26+
# - 'docs/**'
27+
# - 'mkdocs.yml'
28+
# - 'theme/**'
29+
# branches:
30+
# - master
31+
# #
32+
# # If your repository would have releases should you uncomment the below lines
33+
# # in order to ignore pushes caused by newly created releases.
34+
# #
35+
# #tags-ignore:
36+
# #- '**'
37+
38+
jobs:
39+
build:
40+
runs-on: ubuntu-latest
41+
steps:
42+
- uses: actions/checkout@v3
43+
- name: Set up Python 3.9
44+
uses: actions/setup-python@v4
45+
with:
46+
python-version: 3.9
47+
- name: Install dependencies
48+
run: |
49+
python -m pip install --upgrade pip setuptools
50+
python setup.py develop
51+
#python -m pip install -r requirements.txt
52+
53+
- name: Deploy Files
54+
run: |
55+
git config user.name "github-actions[bot]"
56+
git config user.email "actions@github.com"
57+
# python jarvis_leaderboard/rebuild.py
58+
mkdocs build
59+
#rm -r /tmp/site
60+
cp -r site /tmp
61+
git fetch
62+
git checkout nist-pages --force
63+
rm -r *
64+
cp -r /tmp/site/* .
65+
66+
echo 'listing'
67+
ls
68+
echo 'listing tmp'
69+
ls /tmp
70+
git add * */*
71+
git commit -m 'Adding files.'
72+
git push origin nist-pages -f
73+
#git commit -a -m "Move"
74+
#git push -f origin nist-pages1
75+
#mkdocs gh-deploy

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
[![image](https://badge.fury.io/py/jarvis-tools.svg)](https://pypi.org/project/jarvis-tools/)
2+
[![image](https://anaconda.org/conda-forge/jarvis-tools/badges/version.svg)](https://anaconda.org/conda-forge/jarvis-tools)
3+
[![image](https://img.shields.io/github/v/tag/usnistgov/jarvis)](https://github.com/usnistgov/jarvis)
4+
[![image](https://ci.appveyor.com/api/projects/status/d8na8vyfm7ulya9p/branch/master?svg=true)](https://ci.appveyor.com/project/knc6/jarvis-63tl9)
5+
[![image](https://github.com/usnistgov/jarvis/workflows/JARVIS-Tools%20github%20action/badge.svg)](https://github.com/usnistgov/jarvis)
6+
[![image](https://github.com/usnistgov/jarvis/workflows/JARVIS-Tools%20linting/badge.svg)](https://github.com/usnistgov/jarvis)
7+
[![image](https://img.shields.io/codecov/c/github/knc6/jarvis)](https://codecov.io/gh/knc6/jarvis)
8+
[![image](https://img.shields.io/pypi/dm/jarvis-tools.svg)](https://img.shields.io/pypi/dm/jarvis-tools.svg)
9+
[![image](https://pepy.tech/badge/jarvis-tools)](https://pepy.tech/badge/jarvis-tools)
10+
[![image](https://zenodo.org/badge/DOI/10.5281/zenodo.3903515.svg)](https://doi.org/10.5281/zenodo.3903515)
11+
[![image](https://img.shields.io/github/commit-activity/y/usnistgov/jarvis)](https://github.com/usnistgov/jarvis)
12+
[![image](https://img.shields.io/github/repo-size/usnistgov/jarvis)](https://github.com/usnistgov/jarvis)
13+
[![image](https://img.shields.io/badge/JARVIS-Figshare-Green.svg)](https://figshare.com/authors/Kamal_Choudhary/4445539)
14+
[![image](https://img.shields.io/badge/JARVIS-ToolsDocs-Green.svg)](https://pages.nist.gov/jarvis)
15+
[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://github.com/JARVIS-Materials-Design/jarvis-tools-notebooks)
16+
<!-- [![image](https://img.shields.io/travis/usnistgov/jarvis/master.svg?label=Travis%20CI)](https://travis-ci.org/usnistgov/jarvis) -->
17+
------------------------------------------------------------------------
18+
19+
# JARVIS-Tools
20+
21+
The JARVIS-Tools is an open-access software package for atomistic
22+
data-driven materials design. JARVIS-Tools can be used for a) setting up
23+
calculations, b) analysis and informatics, c) plotting, d) database
24+
development and e) web-page development.
25+
26+
Detailed documentation available at: https://pages.nist.gov/jarvis/

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ Installation
8282

8383
bash Miniconda3-latest-Linux-x86_64.sh (for linux)
8484
bash Miniconda3-latest-MacOSX-x86_64.sh (for Mac)
85-
Download 32/64 bit python 3.8 miniconda exe and install (for windows)
85+
Download 32/64 bit python 3.9 miniconda exe and install (for windows)
8686
Now, let's make a conda environment just for JARVIS::
87-
conda create --name my_jarvis python=3.8
87+
conda create --name my_jarvis python=3.9
8888
source activate my_jarvis
8989

9090
- Method-1: Installation using pip::

dev-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ pyasn1-modules==0.2.8
8383
pybind11==2.8.1
8484
PyCifRW==4.4
8585
pycparser==2.21
86-
Pygments==2.10.0
86+
Pygments==2.14
8787
pyparsing==3.0.6
8888
pyrsistent==0.18.0
8989
pytest==6.2.5

docs/assets/css/extensions/tabbed.css

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.tabbed-set {
2+
display: flex;
3+
position: relative;
4+
flex-wrap: wrap;
5+
}
6+
7+
.tabbed-set .highlight {
8+
background: #ddd;
9+
}
10+
11+
.tabbed-set .tabbed-content {
12+
display: none;
13+
order: 99;
14+
width: 100%;
15+
}
16+
17+
.tabbed-set label {
18+
width: auto;
19+
margin: 0 0.5em;
20+
padding: 0.25em;
21+
font-size: 120%;
22+
cursor: pointer;
23+
color: #ffffff !important;
24+
}
25+
26+
.tabbed-set input {
27+
position: absolute;
28+
opacity: 0;
29+
}
30+
31+
.tabbed-set input:nth-child(n+1) {
32+
color: #333333;
33+
}
34+
35+
.tabbed-set input:nth-child(n+1):checked + label {
36+
color: cyan !important;
37+
}
38+
39+
.tabbed-set input:nth-child(n+1):checked + label + .tabbed-content {
40+
display: block;
41+
}

docs/assets/css/extra.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@import "extensions/tabbed.css";

docs/databases.md

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# Databases
2+
3+
## [FigShare](https://figshare.com/authors/Kamal_Choudhary/4445539) based databases
4+
5+
| Database name | Number of data-points | Description |
6+
|-------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------|
7+
| `dft_3d` | 75993 | Various 3D materials properties in JARVIS-DFT database computed with OptB88vdW and TBmBJ methods |
8+
| `dft_2d` | 1109 | Various 2D materials properties in JARVIS-DFT database computed with OptB88vdW |
9+
| `dft_3d_2021` | 55723 | Various 3D materials properties in JARVIS-DFT database computed with OptB88vdW and TBmBJ methods |
10+
| `dft_2d_2021` | 1079 | Various 2D materials properties in JARVIS-DFT database computed with OptB88vdW |
11+
| `qe_tb` | 829574 | Various 3D materials properties in JARVIS-QETB database |
12+
| `stm` | 1132 | 2D materials STM images in JARVIS-STM database |
13+
| `wtbh_electron` | 1440 | 3D and 2D materials Wannier tight-binding Hamiltonian dtaabase for electrons with spin-orbit coupling in JARVIS-WTB (Keyword: 'WANN') |
14+
| `wtbh_phonon` | 15502 | 3D and 2D materials Wannier tight-binding Hamiltonian for phonons at Gamma with finite difference (Keyword:FD-ELAST) |
15+
| `jff` | 2538 | Various 3D materials properties in JARVIS-FF database computed with several force-fields |
16+
| `alignn_ff_db` | 307113 | Energy per atom, forces and stresses for ALIGNN-FF trainig for 75k materials. |
17+
| `edos_pdos` | 48469 | Normalized electron and phonon density of states with interpolated values and fixed number of bins |
18+
| `megnet` | 69239 | Formation energy and bandgaps of 3D materials properties in Materials project database as on 2018, used in megnet |
19+
| `mp_3d_2020` | 127k | CFID descriptors for materials project |
20+
| `mp_3d` | 84k | CFID descriptors for 84k materials project |
21+
| `megnet2` | 133k | 133k materials and their formation energy in MP |
22+
| `twod_matpd` | 6351 | Formation energy and bandgaps of 2D materials properties in 2DMatPedia database |
23+
| `c2db` | 3514 | Various properties in C2DB database |
24+
| `polymer_genome` | 1073 | Electronic bandgap and diecltric constants of crystall ine polymer in polymer genome database |
25+
| `qm9_std_jctc` | 130829 | Various properties of molecules in QM9 database |
26+
| `qm9_dgl` | 130829 | Various properties of molecules in QM9 dgl database |
27+
| `cod` | 431778 | Atomic structures from crystallographic open database |
28+
| `oqmd_3d_no_cfid` | 817636 | Formation energies and bandgaps of 3D materials from OQMD database |
29+
| `oqmd_3d` | 460k | CFID descriptors for 460k materials in OQMD |
30+
| `omdb` | 12500 | Bandgaps for organic polymers in OMDB database |
31+
| `hopv` | 4855 | Various properties of molecules in HOPV15 dataset |
32+
| `pdbbind` | 11189 | Bio-molecular complexes database from PDBBind v2015 |
33+
| `pdbbind_core` | 195 | Bio-molecular complexes database from PDBBind core |
34+
| `qmof` | 20425 | Bandgaps and total energies of metal organic frameowrks in QMOF database |
35+
| `hmof` | 137651 | Hypothetical MOF database |
36+
| `snumat` | 10481 | Bandgaps with hybrid functional |
37+
| `arXiv` | 12500 | arXiv dataset 1.8 million title, abstract and id dataset |
38+
| `ssub` | 1726 | SSUB formation energy for chemical formula dataset |
39+
| `mlearn` | 1730 | Machine learning force-field for elements datasets |
40+
| `ocp10k` | 59886 | Open Catalyst 10000 training, rest validation and test dataset |
41+
| `ocp100k` | 149886 | Open Catalyst 100000 training, rest validation and test dataset |
42+
| `ocp_all` | 510214 | Open Catalyst 460328 training, rest validation and test dataset |
43+
| `tinnet_N` | 329 | TinNet Nitrogen catalyst dataset |
44+
| `tinnet_O` | 747 | TinNet Oxygen catalyst dataset |
45+
| `tinnet_OH` | 748 | TinNet OH group catalyst dataset |
46+
| `AGRA_O` | 1000 | AGRA Oxygen catalyst dataset |
47+
| `AGRA_OH` | 875 | AGRA OH catalyst dataset |
48+
| `AGRA_CO` | 193 | AGRA CO catalyst dataset |
49+
| `AGRA_CHO` | 214 | AGRA CHO catalyst dataset |
50+
| `AGRA_COOH` | 280 | AGRA COOH catalyst dataset |
51+
| `supercon_3d` | 1058 | 3D superconductor DFT dataset |
52+
| `supercon_2d` | 161 | 2D superconductor DFT dataset |
53+
| `supercon_chem` | 16414 | Superconductor chemical formula dataset |
54+
| `vacancydb` | 464 | Vacancy formation energy dataset |
55+
| `cfid_3d` | 55723 | Various 3D materials properties in JARVIS-DFT database computed with OptB88vdW and TBmBJ methods with CFID |
56+
| `raw_files` | 144895 | Figshare links to download raw calculations VASP files from JARVIS-DFT |
57+
58+
All these datasets can be obtained using jarvis-tools as follows,
59+
exception to `stm`, `wtbh_electron`, `wtbh_phonon` which have their own
60+
modules in `jarvis.db.figshare`:
61+
62+
``` python
63+
from jarvis.db.figshare import data
64+
d = data('dft_3d') #choose a name of dataset from above
65+
# See available keys
66+
print (d[0].keys())
67+
# Dataset size
68+
print(len(d))
69+
70+
# Visualize an atoms object
71+
from jarvis.core.atoms import Atoms
72+
a = Atoms.from_dict(d[0]['atoms'])
73+
#You can visualize this in VESTA or other similar packages
74+
print(a)
75+
76+
# If pandas framework needed
77+
import pandas as pd
78+
df = pd.DataFrame(d)
79+
print(df)
80+
```
81+
82+
## JARVIS-DFT
83+
84+
Description coming soon!
85+
86+
### JARVIS-Formation energy and bandgap
87+
88+
### JARVIS-2D Exfoliation energies
89+
90+
### JARVIS-MetaGGA (dielectric function and SLME, solar cells)
91+
92+
### JARVIS-STM and STEM
93+
94+
### JARVIS-WannierTB
95+
96+
### JARVIS-Elastic constants
97+
98+
### JARVIS-Topological materials (Spin-orbit Spillage)
99+
100+
### JARVIS-DFPT (Piezoelectric, IR, Raman, dielectric, BEC)
101+
102+
### JARVIS-BoltzTrap (Thermoelectrics coeff, eff. mass)
103+
104+
### JARVIS-Magnetic moments
105+
106+
### JARVIS-DFPT (Piezoelectric, IR, dielectric)
107+
108+
### JARVIS-EFG
109+
110+
### JARVIS-PBE0 and HSE06
111+
112+
### JARVIS-Heterostructure
113+
114+
### JARVIS-EDOS-PDOS
115+
116+
### JARVIS-Kpoint and cut-off
117+
118+
## JARVIS-FF
119+
120+
### Energetics
121+
122+
### Elastic constants
123+
124+
### Vacancy formation energy
125+
126+
### Surface energy and Wulff-plots
127+
128+
### Phonon DOS
129+
130+
## JARVIS-RAW Files
131+
132+
### JARVIS-DFT structure relaxation
133+
134+
### JARVIS-DFT Elastic constants/finite difference
135+
136+
### JARVIS-WannierTB
137+
138+
### JARVIS-STM and STEM
139+
140+
## External datasets used for ML training
141+
142+
### Materials project dataset
143+
144+
### QM9 dataset
145+
146+
### OQMD dataset
147+
148+
### AFLOW dataset
149+
150+
### Polymer genome dataset
151+
152+
### COD dataset
153+
154+
### OMDB dataset
155+
156+
### QMOF dataset
157+
158+
### C2DB dataset
159+
160+
### HPOV dataset

0 commit comments

Comments
 (0)