You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 line
13 KiB
1 line
13 KiB
Search.setIndex({"alltitles": {"Bibliography": [[0, null]], "Changelog": [[1, null]], "Citing grogupy": [[2, null]], "Command line usage": [[8, "command-line-usage"]], "Contributing to grogupy": [[3, null]], "Environment variables": [[4, null]], "Indices and tables": [[7, "indices-and-tables"]], "Introduction": [[8, null]], "Module contents": [[5, "module-grogupy"]], "Package": [[8, "package"]], "Quickstart": [[9, null]], "Submodules": [[5, "submodules"]], "Tutorials": [[10, null]], "grogupy package": [[5, null]], "grogupy.core module": [[5, "module-grogupy.core"]], "grogupy.grogu module": [[5, "module-grogupy.grogu"]], "grogupy.io module": [[5, "module-grogupy.io"]], "grogupy.magnetism module": [[5, "module-grogupy.magnetism"]], "grogupy.utilities module": [[5, "module-grogupy.utilities"]], "grogupy: Script for calculating magnetic interactions": [[7, null]], "installation": [[9, "installation"]], "src": [[6, null]]}, "docnames": ["bibliography", "changelog/index", "cite", "dev/index", "implementation/environment", "implementation/grogupy", "implementation/modules", "index", "introduction", "quickstart/index", "tutorials/index"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinxcontrib.bibtex": 9}, "filenames": ["bibliography.rst", "changelog/index.rst", "cite.rst", "dev/index.rst", "implementation/environment.rst", "implementation/grogupy.rst", "implementation/modules.rst", "index.rst", "introduction.rst", "quickstart/index.rst", "tutorials/index.rst"], "indexentries": {"blow_up_orbindx() (in module grogupy.magnetism)": [[5, "grogupy.magnetism.blow_up_orbindx", false]], "build_hh_ss() (in module grogupy.core)": [[5, "grogupy.core.build_hh_ss", false]], "calc_vu() (in module grogupy.core)": [[5, "grogupy.core.calc_Vu", false]], "calculate_anisotropy_tensor() (in module grogupy.magnetism)": [[5, "grogupy.magnetism.calculate_anisotropy_tensor", false]], "calculate_exchange_tensor() (in module grogupy.magnetism)": [[5, "grogupy.magnetism.calculate_exchange_tensor", false]], "commutator() (in module grogupy.utilities)": [[5, "grogupy.utilities.commutator", false]], "crossm() (in module grogupy.utilities)": [[5, "grogupy.utilities.crossM", false]], "grogupy": [[5, "module-grogupy", false], [7, "module-grogupy", false]], "grogupy.core": [[5, "module-grogupy.core", false]], "grogupy.grogu": [[5, "module-grogupy.grogu", false]], "grogupy.io": [[5, "module-grogupy.io", false]], "grogupy.magnetism": [[5, "module-grogupy.magnetism", false]], "grogupy.utilities": [[5, "module-grogupy.utilities", false]], "hsk() (in module grogupy.utilities)": [[5, "grogupy.utilities.hsk", false]], "int_de_ke() (in module grogupy.utilities)": [[5, "grogupy.utilities.int_de_ke", false]], "load_pickle() (in module grogupy.io)": [[5, "grogupy.io.load_pickle", false]], "main() (in module grogupy.grogu)": [[5, "grogupy.grogu.main", false]], "make_contour() (in module grogupy.utilities)": [[5, "grogupy.utilities.make_contour", false]], "make_kset() (in module grogupy.utilities)": [[5, "grogupy.utilities.make_kset", false]], "module": [[5, "module-grogupy", false], [5, "module-grogupy.core", false], [5, "module-grogupy.grogu", false], [5, "module-grogupy.io", false], [5, "module-grogupy.magnetism", false], [5, "module-grogupy.utilities", false], [7, "module-grogupy", false]], "onsite_projection() (in module grogupy.core)": [[5, "grogupy.core.onsite_projection", false]], "parallel_gk() (in module grogupy.core)": [[5, "grogupy.core.parallel_Gk", false]], "parse_command_line() (in module grogupy.grogu)": [[5, "grogupy.grogu.parse_command_line", false]], "parse_magnetic_entity() (in module grogupy.magnetism)": [[5, "grogupy.magnetism.parse_magnetic_entity", false]], "print_atoms_and_pairs() (in module grogupy.io)": [[5, "grogupy.io.print_atoms_and_pairs", false]], "print_job_description() (in module grogupy.io)": [[5, "grogupy.io.print_job_description", false]], "print_parameters() (in module grogupy.io)": [[5, "grogupy.io.print_parameters", false]], "print_runtime_information() (in module grogupy.io)": [[5, "grogupy.io.print_runtime_information", false]], "process_input_args() (in module grogupy.io)": [[5, "grogupy.io.process_input_args", false]], "read_fdf() (in module grogupy.io)": [[5, "grogupy.io.read_fdf", false]], "read_siesta_emin() (in module grogupy.utilities)": [[5, "grogupy.utilities.read_siesta_emin", false]], "remove_clutter_for_save() (in module grogupy.core)": [[5, "grogupy.core.remove_clutter_for_save", false]], "rotm() (in module grogupy.utilities)": [[5, "grogupy.utilities.RotM", false]], "rotma2b() (in module grogupy.utilities)": [[5, "grogupy.utilities.RotMa2b", false]], "save_pickle() (in module grogupy.io)": [[5, "grogupy.io.save_pickle", false]], "sequential_gk() (in module grogupy.core)": [[5, "grogupy.core.sequential_GK", false]], "setup_pairs_and_magnetic_entities() (in module grogupy.core)": [[5, "grogupy.core.setup_pairs_and_magnetic_entities", false]], "spin_tracer() (in module grogupy.magnetism)": [[5, "grogupy.magnetism.spin_tracer", false]], "tau_u() (in module grogupy.utilities)": [[5, "grogupy.utilities.tau_u", false]]}, "objects": {"": [[7, 0, 0, "-", "grogupy"]], "grogupy": [[5, 0, 0, "-", "core"], [5, 0, 0, "-", "grogu"], [5, 0, 0, "-", "io"], [5, 0, 0, "-", "magnetism"], [5, 0, 0, "-", "utilities"]], "grogupy.core": [[5, 1, 1, "", "build_hh_ss"], [5, 1, 1, "", "calc_Vu"], [5, 1, 1, "", "onsite_projection"], [5, 1, 1, "", "parallel_Gk"], [5, 1, 1, "", "remove_clutter_for_save"], [5, 1, 1, "", "sequential_GK"], [5, 1, 1, "", "setup_pairs_and_magnetic_entities"]], "grogupy.grogu": [[5, 1, 1, "", "main"], [5, 1, 1, "", "parse_command_line"]], "grogupy.io": [[5, 1, 1, "", "load_pickle"], [5, 1, 1, "", "print_atoms_and_pairs"], [5, 1, 1, "", "print_job_description"], [5, 1, 1, "", "print_parameters"], [5, 1, 1, "", "print_runtime_information"], [5, 1, 1, "", "process_input_args"], [5, 1, 1, "", "read_fdf"], [5, 1, 1, "", "save_pickle"]], "grogupy.magnetism": [[5, 1, 1, "", "blow_up_orbindx"], [5, 1, 1, "", "calculate_anisotropy_tensor"], [5, 1, 1, "", "calculate_exchange_tensor"], [5, 1, 1, "", "parse_magnetic_entity"], [5, 1, 1, "", "spin_tracer"]], "grogupy.utilities": [[5, 1, 1, "", "RotM"], [5, 1, 1, "", "RotMa2b"], [5, 1, 1, "", "commutator"], [5, 1, 1, "", "crossM"], [5, 1, 1, "", "hsk"], [5, 1, 1, "", "int_de_ke"], [5, 1, 1, "", "make_contour"], [5, 1, 1, "", "make_kset"], [5, 1, 1, "", "read_siesta_emin"], [5, 1, 1, "", "tau_u"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": 5, "0": 5, "1": [5, 8], "10": 5, "150": 5, "1e": 5, "2": 5, "20": 5, "3": 5, "42": 5, "93": 5, "96": 5, "A": 5, "If": 5, "It": 5, "NO": 5, "The": [5, 8], "These": 5, "abov": 5, "accepted_input": 5, "act": 5, "all": 5, "along": 5, "an": 5, "angl": 5, "angular": 5, "anisotropi": 5, "ar": 5, "arbitrari": 5, "arg": 5, "argument": 5, "around": 5, "arrai": 5, "array_lik": 5, "associ": 5, "atom": 5, "awai": 5, "ax": 5, "axi": 5, "b": 5, "background": 7, "base": [5, 7, 8], "basi": 5, "basic": [5, 7], "befor": 5, "blow": 5, "blow_up_orbindx": [5, 6], "box": 5, "brillouin": 5, "build": 5, "build_hh_ss": [5, 6], "c": 5, "calc_vu": [5, 6], "calcul": 5, "calculate_anisotropy_tensor": [5, 6], "calculate_exchange_tensor": [5, 6], "can": [5, 7, 9], "case": 5, "ccont": 5, "cell": 5, "channel": 5, "class": 5, "come": [1, 2, 3, 4, 8, 9, 10], "command": 5, "command_line_argu": 5, "commut": [5, 6], "complet": 5, "complex": 5, "constant": 5, "contain": 5, "content": 6, "contour": 5, "convent": 5, "coordin": 5, "core": 6, "creat": 5, "cross": 5, "crossm": [5, 6], "cutoff": 5, "d": 5, "data": 5, "default": 5, "default_argu": 5, "defin": 5, "definit": 5, "depend": 5, "describ": 5, "descript": [5, 7], "detail": 7, "dft": 7, "dh": 5, "dict": 5, "dictionari": 5, "dimens": 5, "dir": 5, "direct": 5, "distribut": 5, "dm": 5, "docstr": 5, "document": 8, "doe": 5, "done": 5, "dose": 5, "down": 5, "dx": 5, "dy": 5, "dz": 5, "dzyaloshinskii": 5, "ebot": 5, "eig": 5, "eigenvalu": 5, "eigfil": 5, "either": 5, "element": 5, "emax": 5, "emin": 5, "energi": 5, "entiti": 5, "enum": 5, "ep": 5, "equat": 5, "eran": 5, "eset": 5, "esetp": 5, "exchang": 5, "extract": 5, "faster": 5, "fdf": 5, "fdf_argument": 5, "fermi": 5, "file": 5, "fill": 5, "final": 5, "first": 5, "flatten": 5, "float": 5, "form": 5, "format": 8, "formula": 5, "from": [5, 9], "function": 5, "furthermor": 5, "gauss": 5, "gener": [5, 7], "given": 5, "gk": 5, "go": 8, "green": 5, "grid": 5, "grogu": [6, 7], "grogupi": [6, 9], "groupi": 7, "guid": 7, "h": 5, "hamiltonian": 5, "here": 7, "hh": 5, "hk": 5, "hold": 5, "how": 7, "hsk": [5, 6], "http": 9, "i": [5, 7], "idx": 5, "idx1": 5, "idx2": 5, "implement": 7, "index": [5, 7, 9], "indic": 5, "infil": 5, "inform": 5, "init": 5, "initi": 5, "input": 5, "inspir": 8, "instal": 8, "int": 5, "int_de_k": [5, 6], "integ": 5, "integr": 5, "invers": 5, "io": 6, "isotrop": 5, "j": 5, "j_": 5, "j_iso": 5, "job": 5, "jxx": 5, "jxy": 5, "jxz": 5, "jyi": 5, "jyx": 5, "jyz": 5, "jzx": 5, "jzy": 5, "jzz": 5, "k": 5, "kdir": 5, "kset": 5, "kwarg": 5, "l": 5, "last": 5, "lattic": 5, "legendr": 5, "level": 5, "line": 5, "list": 5, "load": 5, "load_pickl": [5, 6], "local": 5, "lowest": 5, "m": [5, 9], "mag_ent": 5, "magnet": 6, "magnetic interact": 7, "magnetic_ent": 5, "main": [5, 6], "make": 5, "make_contour": [5, 6], "make_kset": [5, 6], "mathemat": 5, "matlab": 7, "matric": 5, "matrix": 5, "maximum": 5, "merg": 5, "method": 5, "minimum": 5, "modul": [6, 7], "momentum": 5, "more": [5, 7], "morilla": 5, "n": 5, "need": 5, "none": 5, "np": 5, "number": 5, "numer": 5, "numk": 5, "numpi": 5, "onsite_project": [5, 6], "oper": 5, "option": 5, "orb_indic": 5, "orbit": 5, "order": 5, "org": 9, "origin": 5, "out": 5, "outfil": 5, "output": 5, "over": 5, "overlap": 5, "p": 5, "packag": 6, "padawan_mod": 5, "page": 7, "pair": 5, "parallel_gk": [5, 6], "parallel_solver_for_gk": 5, "paramet": 5, "parse_command_lin": [5, 6], "parse_magnetic_ent": [5, 6], "path": 5, "pauli": 5, "perturb": 5, "physic": [5, 7], "pickl": 5, "pip": 9, "point": 5, "pont": 5, "post": 5, "potenti": 5, "print": 5, "print_atoms_and_pair": [5, 6], "print_job_descript": [5, 6], "print_paramet": [5, 6], "print_runtime_inform": [5, 6], "prioriti": 5, "process": 5, "process_input_arg": [5, 6], "produc": 5, "product": 5, "project": 5, "properti": 5, "pypi": 9, "python": 7, "python3": 9, "quadratur": 5, "quick": 7, "quickstart": 7, "r": 5, "read": 5, "read_fdf": [5, 6], "read_siesta_emin": [5, 6], "reduc": 5, "ref_xcf_orient": 5, "relev": 5, "remov": 5, "remove_clutter_for_sav": [5, 6], "renorm": 5, "repres": 5, "represent": 5, "restructur": 5, "result": 5, "return": 5, "rotat": 5, "rotm": [5, 6], "rotma2b": [5, 6], "run": 5, "runtim": 5, "same": 5, "sampl": 5, "save": 5, "save_pickl": [5, 6], "sc_off": 5, "scf_xcf_orient": 5, "search": 7, "second": 5, "seen": 7, "sens": 5, "sequenc": 5, "sequenti": 5, "sequential_gk": [5, 6], "set": 5, "setup_pairs_and_magnetic_ent": [5, 6], "shape": 5, "shorthand": 5, "siesta": [5, 7], "simpl": [5, 9], "simul": 5, "simulation_paramet": 5, "singl": 5, "sisl": [5, 8], "site": 5, "sk": 5, "slice": 5, "small": 5, "so": 5, "some": 5, "soon": [1, 2, 3, 4, 8, 9, 10], "sophist": 5, "sourc": 5, "speed": 5, "spin": 5, "spin_trac": [5, 6], "src": 7, "ss": 5, "start": 7, "str": 5, "string": 5, "structur": 5, "submodul": 6, "supercel": 5, "symmetr": 5, "tag": 5, "take": 5, "tau_u": [5, 6], "teh": 5, "tensor": 5, "test": 9, "thei": 5, "theoret": 7, "theta": 5, "thi": 5, "three": 5, "throw": 5, "time": 5, "total": 5, "tr": 5, "trace": 5, "traceabl": 5, "tracer": 5, "trapz": 5, "tu": 5, "tupl": 5, "tutori": 7, "two": 5, "u": 5, "uniformli": 5, "unimport": 5, "unit": 5, "up": 5, "url": 9, "us": [5, 7], "util": 6, "valu": 5, "vector": 5, "version": 5, "via": 9, "vu1": 5, "vu2": 5, "wa": 8, "we": 5, "weight": 5, "where": 5, "wrapper": 5, "x": 5, "xyz": 5, "y": 5, "z": 5, "zone": 5}, "titles": ["Bibliography", "Changelog", "Citing grogupy", "Contributing to grogupy", "Environment variables", "grogupy package", "src", "grogupy: Script for calculating magnetic interactions", "Introduction", "Quickstart", "Tutorials"], "titleterms": {"bibliographi": 0, "calcul": 7, "changelog": 1, "cite": 2, "command": 8, "content": 5, "contribut": 3, "core": 5, "environ": 4, "grogu": 5, "grogupi": [2, 3, 5, 7], "indic": 7, "instal": 9, "interact": 7, "introduct": 8, "io": 5, "line": 8, "magnet": [5, 7], "modul": 5, "packag": [5, 8], "quickstart": 9, "script": 7, "src": 6, "submodul": 5, "tabl": 7, "tutori": 10, "usag": 8, "util": 5, "variabl": 4}}) |