Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
SotaYoshida authored Oct 31, 2023
1 parent 908b2a4 commit adc22d7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/src/howtouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ In this page, we explain the main interfaces of NuclearToolkit.jl and sample cod

## Generate Chiral EFT potentials

The [ChiEFTint](../ChiEFTint) subblock provides the codes to generate nucleon-nucleon (NN) potentials from Chiral effective field theory. You can specify the options through `optional_parameters.jl`, if it exists in the working directory.
A sample of `optional_parameters.jl` is available on the [repository](https://github.com/SotaYoshida/NuclearToolkit.jl), and see the [Optional parameters](../parameters) page for more details.
The [ChiEFTint](ChiEFTint.md) subblock provides the codes to generate nucleon-nucleon (NN) potentials from Chiral effective field theory. You can specify the options through `optional_parameters.jl`, if it exists in the working directory.
A sample of `optional_parameters.jl` is available on the [repository](https://github.com/SotaYoshida/NuclearToolkit.jl), and see the [Optional parameters](parameters.md) page for more details.

The main API is `make_chiEFTint()` and the sample code is given below.
```julia
Expand Down Expand Up @@ -40,7 +40,7 @@ When working on a working node (w/o permissions to access `~/`), overwrite the `

## HF-MBPT calculations

You can evaluate ground state properties by the so-called Hartree-Fock many-body perturbation theory (HF-MBPT). The `hf_main` function in [HartreeFock](../HartreeFock) is the main interface.
You can evaluate ground state properties by the so-called Hartree-Fock many-body perturbation theory (HF-MBPT). The `hf_main` function in [HartreeFock](HartreeFock.md) is the main interface.

You must specify target nuclei, snt file (generated by chiEFTint), harmonic oscillator parameter `hw`, model space size `emax`.

Expand Down
10 changes: 5 additions & 5 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,28 @@ In the author's personal opinion, it would be too difficult for students (especi
The author thought the Julia language can be a game changer to this situation with its high readbility, portabillity, and performance. Since all the source code in NuclearToolkit.jl is a pure Julia implementation, there is no more need to prepare different Makefiles for different environments, worry about library dependencies, homemade Python script to run the Fortran/C++ codes. The code can be easily executed on either a laptop or a supercomputer.
While NuclearToolkit covers a wide range of methods, the overall code length is still in a few tens of thousands, including "docstring" to generate the document.

- [ChiEFTint](ChiEFTint): NN interaction from Chiral EFT ~ 6,000 lines.
- [ChiEFTint](ChiEFTint.md): NN interaction from Chiral EFT ~ 6,000 lines.
- EM (Entem & Machleidt) N3L0
- EMN (Entem, Machleidt, Nosyc) N4LO
- Density-Dependent NN from 3NF (The author prefers to call it "2n3n" to distinguish with genuine 3NF)
- valence chiral EFT potential upto LO
- [Hartreefock](HartreeFock): Hartree-Fock (HF) and HF Many-Body Perturbation Theory (HFMBPT) ~ 3,000 lines.
- [Hartreefock](HartreeFock.md): Hartree-Fock (HF) and HF Many-Body Perturbation Theory (HFMBPT) ~ 3,000 lines.
- Energy (up to 3rd order)
- Scaler operator (up to 2nd order)
- [IMSRG](IMSRG): In-medium Similarity Renormalization Group (IMSRG) ~ 2,000 lines.
- [IMSRG](IMSRG.md): In-medium Similarity Renormalization Group (IMSRG) ~ 2,000 lines.
- IMSRG(2) calc. for ground state energy
- consistent IMSRG(2) flow of (scaler) operator
- Valence-space IMSRG (VS-IMSRG)
- derive effective interaction for shell-model calculations
- consistent VSIMSRG flow to get effective operators
- [ShellModel.jl](ShellModel) ~ 5,000 lines.
- [ShellModel.jl](ShellModel.md) ~ 5,000 lines.
This was originally developed as [an independent package] (https://github.com/SotaYoshida/ShellModel.jl).
- shell model calculations
- construct approximate wavefunctions with eigenvector continuation

## Optional parameters
For some parameters, the default values are used unless the user specifies those in the file, `optional_parameters.jl`.
See the [Optional parameters](parameters) page for more details.
See the [Optional parameters](parameters.md) page for more details.

## Issues/Pull requests

Expand Down

0 comments on commit adc22d7

Please sign in to comment.