Skip to content

Commit

Permalink
Develop (#293)
Browse files Browse the repository at this point in the history
* 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 <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>

* First input.

* added black

* Example folder.

Co-authored-by: Kamal Choudhary <[email protected]>
Co-authored-by: tavazza <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>

* 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 <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>

* First input.

* added black

* Example folder.

Co-authored-by: Kamal Choudhary <[email protected]>
Co-authored-by: tavazza <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>

* 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 <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>
Co-authored-by: wines1 <[email protected]>

* 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 <[email protected]>
Co-authored-by: tavazza <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>
Co-authored-by: wines1 <[email protected]>

* 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 <[email protected]>
Co-authored-by: knc6 <[email protected]>
Co-authored-by: KAMAL CHOUDHARY <[email protected]>
Co-authored-by: wines1 <[email protected]>
Co-authored-by: Saurav Maheshkar <[email protected]>
Co-authored-by: Janosh Riebesell <[email protected]>
Co-authored-by: Ramya Gurunathan <[email protected]>
  • Loading branch information
8 people authored Aug 11, 2023
1 parent 7807e8f commit 3328ed8
Show file tree
Hide file tree
Showing 26 changed files with 2,709 additions and 66 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/NISTtheDocs2Death.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: "Build Documentation"

on: [push, pull_request, delete]

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: usnistgov/[email protected]
with:
docs-folder: docs/
formats: |-
epub
pdf
2 changes: 1 addition & 1 deletion .github/workflows/action_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.8,3.9]
python-version: [3.9]
steps:
- uses: actions/checkout@v2
- name: Setup Python ${{ matrix.python-version }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/action_lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
strategy:
max-parallel: 4
matrix:
python-version: [3.7]
python-version: [3.9]

steps:
- uses: actions/checkout@v1
Expand Down
75 changes: 75 additions & 0 deletions .github/workflows/deploy_nist_pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
#
# This is a working example of using GitHub Actions to publish the docs
# to the GitHub Pages (gh_pages) branch.
#
# Remember to have a requirements.txt file with the required dependencies.
# This template ships with one by default.
#
# It is also recommendet to also copy the template with all branches, to
# have the gh-pages branch pre-made. This prevents possible errors.
#
name: Deploy Site

# on: [push, pull_request]

on:
push:
branches:
- master

permissions:
contents: write

# on:
# push:
# paths:
# - 'docs/**'
# - 'mkdocs.yml'
# - 'theme/**'
# branches:
# - master
# #
# # If your repository would have releases should you uncomment the below lines
# # in order to ignore pushes caused by newly created releases.
# #
# #tags-ignore:
# #- '**'

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.9
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools
python setup.py develop
#python -m pip install -r requirements.txt
- name: Deploy Files
run: |
git config user.name "github-actions[bot]"
git config user.email "[email protected]"
# python jarvis_leaderboard/rebuild.py
mkdocs build
#rm -r /tmp/site
cp -r site /tmp
git fetch
git checkout nist-pages --force
rm -r *
cp -r /tmp/site/* .
echo 'listing'
ls
echo 'listing tmp'
ls /tmp
git add * */*
git commit -m 'Adding files.'
git push origin nist-pages -f
#git commit -a -m "Move"
#git push -f origin nist-pages1
#mkdocs gh-deploy
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[![image](https://badge.fury.io/py/jarvis-tools.svg)](https://pypi.org/project/jarvis-tools/)
[![image](https://anaconda.org/conda-forge/jarvis-tools/badges/version.svg)](https://anaconda.org/conda-forge/jarvis-tools)
[![image](https://img.shields.io/github/v/tag/usnistgov/jarvis)](https://github.com/usnistgov/jarvis)
[![image](https://ci.appveyor.com/api/projects/status/d8na8vyfm7ulya9p/branch/master?svg=true)](https://ci.appveyor.com/project/knc6/jarvis-63tl9)
[![image](https://github.com/usnistgov/jarvis/workflows/JARVIS-Tools%20github%20action/badge.svg)](https://github.com/usnistgov/jarvis)
[![image](https://github.com/usnistgov/jarvis/workflows/JARVIS-Tools%20linting/badge.svg)](https://github.com/usnistgov/jarvis)
[![image](https://img.shields.io/codecov/c/github/knc6/jarvis)](https://codecov.io/gh/knc6/jarvis)
[![image](https://img.shields.io/pypi/dm/jarvis-tools.svg)](https://img.shields.io/pypi/dm/jarvis-tools.svg)
[![image](https://pepy.tech/badge/jarvis-tools)](https://pepy.tech/badge/jarvis-tools)
[![image](https://zenodo.org/badge/DOI/10.5281/zenodo.3903515.svg)](https://doi.org/10.5281/zenodo.3903515)
[![image](https://img.shields.io/github/commit-activity/y/usnistgov/jarvis)](https://github.com/usnistgov/jarvis)
[![image](https://img.shields.io/github/repo-size/usnistgov/jarvis)](https://github.com/usnistgov/jarvis)
[![image](https://img.shields.io/badge/JARVIS-Figshare-Green.svg)](https://figshare.com/authors/Kamal_Choudhary/4445539)
[![image](https://img.shields.io/badge/JARVIS-ToolsDocs-Green.svg)](https://pages.nist.gov/jarvis)
[![image](https://colab.research.google.com/assets/colab-badge.svg)](https://github.com/JARVIS-Materials-Design/jarvis-tools-notebooks)
<!-- [![image](https://img.shields.io/travis/usnistgov/jarvis/master.svg?label=Travis%20CI)](https://travis-ci.org/usnistgov/jarvis) -->
------------------------------------------------------------------------

# JARVIS-Tools

The JARVIS-Tools is an open-access software package for atomistic
data-driven materials design. JARVIS-Tools can be used for a) setting up
calculations, b) analysis and informatics, c) plotting, d) database
development and e) web-page development.

Detailed documentation available at: https://pages.nist.gov/jarvis/
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ Installation

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

- Method-1: Installation using pip::
Expand Down
2 changes: 1 addition & 1 deletion dev-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ pyasn1-modules==0.2.8
pybind11==2.8.1
PyCifRW==4.4
pycparser==2.21
Pygments==2.10.0
Pygments==2.14
pyparsing==3.0.6
pyrsistent==0.18.0
pytest==6.2.5
Expand Down
41 changes: 41 additions & 0 deletions docs/assets/css/extensions/tabbed.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.tabbed-set {
display: flex;
position: relative;
flex-wrap: wrap;
}

.tabbed-set .highlight {
background: #ddd;
}

.tabbed-set .tabbed-content {
display: none;
order: 99;
width: 100%;
}

.tabbed-set label {
width: auto;
margin: 0 0.5em;
padding: 0.25em;
font-size: 120%;
cursor: pointer;
color: #ffffff !important;
}

.tabbed-set input {
position: absolute;
opacity: 0;
}

.tabbed-set input:nth-child(n+1) {
color: #333333;
}

.tabbed-set input:nth-child(n+1):checked + label {
color: cyan !important;
}

.tabbed-set input:nth-child(n+1):checked + label + .tabbed-content {
display: block;
}
1 change: 1 addition & 0 deletions docs/assets/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import "extensions/tabbed.css";
160 changes: 160 additions & 0 deletions docs/databases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Databases

## [FigShare](https://figshare.com/authors/Kamal_Choudhary/4445539) based databases

| Database name | Number of data-points | Description |
|-------------------|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| `dft_3d` | 75993 | Various 3D materials properties in JARVIS-DFT database computed with OptB88vdW and TBmBJ methods |
| `dft_2d` | 1109 | Various 2D materials properties in JARVIS-DFT database computed with OptB88vdW |
| `dft_3d_2021` | 55723 | Various 3D materials properties in JARVIS-DFT database computed with OptB88vdW and TBmBJ methods |
| `dft_2d_2021` | 1079 | Various 2D materials properties in JARVIS-DFT database computed with OptB88vdW |
| `qe_tb` | 829574 | Various 3D materials properties in JARVIS-QETB database |
| `stm` | 1132 | 2D materials STM images in JARVIS-STM database |
| `wtbh_electron` | 1440 | 3D and 2D materials Wannier tight-binding Hamiltonian dtaabase for electrons with spin-orbit coupling in JARVIS-WTB (Keyword: 'WANN') |
| `wtbh_phonon` | 15502 | 3D and 2D materials Wannier tight-binding Hamiltonian for phonons at Gamma with finite difference (Keyword:FD-ELAST) |
| `jff` | 2538 | Various 3D materials properties in JARVIS-FF database computed with several force-fields |
| `alignn_ff_db` | 307113 | Energy per atom, forces and stresses for ALIGNN-FF trainig for 75k materials. |
| `edos_pdos` | 48469 | Normalized electron and phonon density of states with interpolated values and fixed number of bins |
| `megnet` | 69239 | Formation energy and bandgaps of 3D materials properties in Materials project database as on 2018, used in megnet |
| `mp_3d_2020` | 127k | CFID descriptors for materials project |
| `mp_3d` | 84k | CFID descriptors for 84k materials project |
| `megnet2` | 133k | 133k materials and their formation energy in MP |
| `twod_matpd` | 6351 | Formation energy and bandgaps of 2D materials properties in 2DMatPedia database |
| `c2db` | 3514 | Various properties in C2DB database |
| `polymer_genome` | 1073 | Electronic bandgap and diecltric constants of crystall ine polymer in polymer genome database |
| `qm9_std_jctc` | 130829 | Various properties of molecules in QM9 database |
| `qm9_dgl` | 130829 | Various properties of molecules in QM9 dgl database |
| `cod` | 431778 | Atomic structures from crystallographic open database |
| `oqmd_3d_no_cfid` | 817636 | Formation energies and bandgaps of 3D materials from OQMD database |
| `oqmd_3d` | 460k | CFID descriptors for 460k materials in OQMD |
| `omdb` | 12500 | Bandgaps for organic polymers in OMDB database |
| `hopv` | 4855 | Various properties of molecules in HOPV15 dataset |
| `pdbbind` | 11189 | Bio-molecular complexes database from PDBBind v2015 |
| `pdbbind_core` | 195 | Bio-molecular complexes database from PDBBind core |
| `qmof` | 20425 | Bandgaps and total energies of metal organic frameowrks in QMOF database |
| `hmof` | 137651 | Hypothetical MOF database |
| `snumat` | 10481 | Bandgaps with hybrid functional |
| `arXiv` | 12500 | arXiv dataset 1.8 million title, abstract and id dataset |
| `ssub` | 1726 | SSUB formation energy for chemical formula dataset |
| `mlearn` | 1730 | Machine learning force-field for elements datasets |
| `ocp10k` | 59886 | Open Catalyst 10000 training, rest validation and test dataset |
| `ocp100k` | 149886 | Open Catalyst 100000 training, rest validation and test dataset |
| `ocp_all` | 510214 | Open Catalyst 460328 training, rest validation and test dataset |
| `tinnet_N` | 329 | TinNet Nitrogen catalyst dataset |
| `tinnet_O` | 747 | TinNet Oxygen catalyst dataset |
| `tinnet_OH` | 748 | TinNet OH group catalyst dataset |
| `AGRA_O` | 1000 | AGRA Oxygen catalyst dataset |
| `AGRA_OH` | 875 | AGRA OH catalyst dataset |
| `AGRA_CO` | 193 | AGRA CO catalyst dataset |
| `AGRA_CHO` | 214 | AGRA CHO catalyst dataset |
| `AGRA_COOH` | 280 | AGRA COOH catalyst dataset |
| `supercon_3d` | 1058 | 3D superconductor DFT dataset |
| `supercon_2d` | 161 | 2D superconductor DFT dataset |
| `supercon_chem` | 16414 | Superconductor chemical formula dataset |
| `vacancydb` | 464 | Vacancy formation energy dataset |
| `cfid_3d` | 55723 | Various 3D materials properties in JARVIS-DFT database computed with OptB88vdW and TBmBJ methods with CFID |
| `raw_files` | 144895 | Figshare links to download raw calculations VASP files from JARVIS-DFT |

All these datasets can be obtained using jarvis-tools as follows,
exception to `stm`, `wtbh_electron`, `wtbh_phonon` which have their own
modules in `jarvis.db.figshare`:

``` python
from jarvis.db.figshare import data
d = data('dft_3d') #choose a name of dataset from above
# See available keys
print (d[0].keys())
# Dataset size
print(len(d))

# Visualize an atoms object
from jarvis.core.atoms import Atoms
a = Atoms.from_dict(d[0]['atoms'])
#You can visualize this in VESTA or other similar packages
print(a)

# If pandas framework needed
import pandas as pd
df = pd.DataFrame(d)
print(df)
```

## JARVIS-DFT

Description coming soon!

### JARVIS-Formation energy and bandgap

### JARVIS-2D Exfoliation energies

### JARVIS-MetaGGA (dielectric function and SLME, solar cells)

### JARVIS-STM and STEM

### JARVIS-WannierTB

### JARVIS-Elastic constants

### JARVIS-Topological materials (Spin-orbit Spillage)

### JARVIS-DFPT (Piezoelectric, IR, Raman, dielectric, BEC)

### JARVIS-BoltzTrap (Thermoelectrics coeff, eff. mass)

### JARVIS-Magnetic moments

### JARVIS-DFPT (Piezoelectric, IR, dielectric)

### JARVIS-EFG

### JARVIS-PBE0 and HSE06

### JARVIS-Heterostructure

### JARVIS-EDOS-PDOS

### JARVIS-Kpoint and cut-off

## JARVIS-FF

### Energetics

### Elastic constants

### Vacancy formation energy

### Surface energy and Wulff-plots

### Phonon DOS

## JARVIS-RAW Files

### JARVIS-DFT structure relaxation

### JARVIS-DFT Elastic constants/finite difference

### JARVIS-WannierTB

### JARVIS-STM and STEM

## External datasets used for ML training

### Materials project dataset

### QM9 dataset

### OQMD dataset

### AFLOW dataset

### Polymer genome dataset

### COD dataset

### OMDB dataset

### QMOF dataset

### C2DB dataset

### HPOV dataset
Loading

0 comments on commit 3328ed8

Please sign in to comment.