Getting started

less than 1 minute read

Quick start (Install & run example)

The single script will install Julia & DFTforge & Jx

git clone https://github.com/KAIST-ELST/Jx.jl
cd Jx.jl
./install_julia_linux_mac.sh

Run example

./example_NiO_OpenMX.sh

The ./example_NiO_OpenMX.sh script will perform the MFT calculation for G-type antiferromagnetic NiO. Details are as follows:

  1. Extract the NiO Hamiltonian result file precomputed with OpenMX, and
  2. Perform the MFT calculation.
  3. Save Jij to CSV files and plot Jij to PDF file.

Step-by-step installation

1. Download the Jx code

git clone https://github.com/KAIST-ELST/Jx.jl

2. Install Julia

Julia1.6 Julia1.7 Julia1.8 Julia1.9

Currently, we support the latest Julia 1.6-1.9.* (https://julialang.org/)

  • For Linux system:

Using Julia auto-installer for Linux

#echo 'export PATH=~/opt/bin:$PATH' >>~/.profile
#echo 'export PATH=~/opt/bin:$PATH' >>~/.bashrc
#JULIA_INSTALL=~/opt/bin bash -ci "$(curl –fsSL #https://raw.githubusercontent.com/abelsiqueira/jill/master/jill.sh)"
curl -fsSL https://install.julialang.org | sh
  • For OSX

Install Homebrew

brew cask install juliaup
brew cask upgrade juliaup

3. Install DFTforge

import Pkg
Pkg.add("DFTforge")

4. Run example

G-type AFM (anti-ferromagnetic) NiO example

./example_NiO_OpenMX.sh

See the NiO example page for the procedure the script does.