jarvis.db.figshare
==================

.. py:module:: jarvis.db.figshare

.. autoapi-nested-parse::

   Downloads files from Figshare.

   Main page: https://figshare.com/authors/Kamal_Choudhary/4445539



Functions
---------

.. autoapisummary::

   jarvis.db.figshare.get_db_info
   jarvis.db.figshare.get_stm_2d_dataset
   jarvis.db.figshare.get_request_data
   jarvis.db.figshare.data
   jarvis.db.figshare.get_jid_data
   jarvis.db.figshare.get_ff_eneleast
   jarvis.db.figshare.make_stm_from_prev_parchg
   jarvis.db.figshare.get_wann_electron
   jarvis.db.figshare.get_wann_phonon
   jarvis.db.figshare.get_hk_tb


Module Contents
---------------

.. py:function:: get_db_info()

   Get DB info.


.. py:function:: get_stm_2d_dataset()

   Get 2D STM image dataset.


.. py:function:: get_request_data(js_tag='jdft_2d-4-26-2020.json', url='https://figshare.com/ndownloader/files/22471019', store_dir=None)

   Get data with progress bar.


.. py:function:: data(dataset='dft_2d', store_dir=None)

   Provide main function to download datasets.


.. py:function:: get_jid_data(jid='JVASP-667', dataset='dft_2d')

   Get info eor a jid and dataset.


.. py:function:: get_ff_eneleast()

   Get JARVIS-FF related data.


.. py:function:: make_stm_from_prev_parchg(jid='JVASP-667', bias='Negative', filename='stm_image.png', min_size=10)

   Make STM images from previously calculated PARVHG files for 2D.


.. py:function:: get_wann_electron(jid='JVASP-816')

   Download electron WTBH if available.


.. py:function:: get_wann_phonon(jid='JVASP-1002', factor=15.633302)

   Download phonon WTBH if available.


.. py:function:: get_hk_tb(k=np.array([0, 0, 0]), w=[])

   Get Wannier TB Hamiltonian.