grogu package

Submodules

grogu.example module

grogu.jij module

grogu.useful module

grogu.useful.add(x, y)

The sum of two numbers for testing.

This function adds to numbers together. I only created this for testing documentation and examples.

Parameters:

• x (float) – First number

• y (float) – Second number added to x

Returns:

sum – The sum of the inputs

Return type:

int

See also

numpy.add

Adds more than two numbers.

Notes

We can create some latex notes here [1] :

\[a + b = c\]

References

[1]

https://numpydoc.readthedocs.io/en/latest/format.html

Examples

>>> add(1, 2)
3

grogu.useful.hsk(dh, k=(0, 0, 0))

One way to speed up Hk and Sk generation

grogu.useful.make_atran(nauc, dirs='xyz', dist=1)

Simple pair generator. Depending on the value of the dirs argument sampling in 1,2 or 3 dimensions is generated. If dirs argument does not contain either of x,y or z a single pair is returend.

grogu.useful.make_contour(emin=-20, emax=0.0, enum=42, p=150)

A more sophisticated contour generator

grogu.useful.make_kset(dirs='xyz', NUMK=20)

Simple k-grid generator. Depending on the value of the dirs argument k sampling in 1,2 or 3 dimensions is generated. If dirs argument does not contain either of x,y or z a kset of a single k-pont at the origin is returend.

Module contents