SotaYoshida / NuclearToolkit.jl

NuclearToolkit.jl: Julia package for nuclear structure calculations
MIT License
26 stars 6 forks source link

NuclearToolkit.jl

Stable Dev Build Status DOI

Julia package for nuclear structure calculations covering:

Note: Of course, 'for structural calculations' simply means that the author (SY) is not familiar with reaction theories. Contributions and suggestions from reaction theory and experimental researchers are very welcome. Thanks.

Installation

Assuming that you have already installed Julia (v>=1.7.0),

julia>using Pkg; Pkg.add("NuclearToolkit")

Pkg (Julia's builtin package manager) intalls packages in $JULIA_DEPOT_PATH, which is by default ~/.julia.
When working on a working node (w/o permissions to access ~/), overwrite the JULIA_DEPOT_PATH by export JULIA_DEPOT_PATH="PATH_TO_JULIA_DEPOT".

How to START

Execute example/sample_script.jl like

julia -t 10 example/sample_script.jl

This sample script performs:

How to cite

When you use NuclearToolkit.jl in your work, please cite the JOSS paper:https://doi.org/10.21105/joss.04694

@article{Yoshida2022,
doi = {10.21105/joss.04694}, 
url = {https://doi.org/10.21105/joss.04694}, 
year = {2022}, 
publisher = {The Open Journal}, 
volume = {7}, number = {79}, pages = {4694}, 
author = {Sota Yoshida}, 
title = {NuclearToolkit.jl: A Julia package for nuclear structure calculations}, 
journal = {Journal of Open Source Software} }