Quick start - xination/lvl_builder GitHub Wiki

Let's talk about the basic of the input file.
There are only two categories -- level and gamma.
a line starts with "#" will be treated as a comment. and an empty line will be ignore.
The format is @key1 value1 @key2 value2 ....

For a level, there are two required key-value pairs -- lvlE and bandN. For example:
@lvlE 0 @bandN 1 , you create a level at energy 0, and it locates at bandN ( region ) = 1.
@lvlE 100 @bandN 1 , now you know this is to create a level at energy =100, and at bandN 1.

By default, lvlE = 100 or 100.0 or 100.1 will all display as a level at 100, since the levelDigit is set to 0 in the fine_control_paramter_file file. But they are treated as different levels. You can use this as a trick to set the second "ground state".

bandN can either positive, negative value or 0,
and you can create a level across multiple band by use "_", ex. 2_3,
or -1_3, which will cross from bandN = -1 to bandN = 3.

For a gamma, and we have two required key-value pairs; they are Ei adn Ef -- the energies for the initial state and final state. For example:
@Ei 100 @Ef 0 , we will connect the states with an arrowed line.

You can notice the gamma automatically changes its placement when we adjust its levels. Furthermore, when an initial state and a final state are too far away, we will add an auxiliary dashed line. (You can also define how far to let the auxiliary line appears, which can be set in the fine_control_paramter_file. )

Now, you have learn the most essential part of lvl_builder program, and you are good to explore more options.
Just remember: for a level, we require "lvlE" and "bandN", for a gamma "Ei" and "Ef" are required.