Welcome to PyHopf’s Documentation!

This package provides Python implementations of the calculation of the Hopf index of the magnetisation texture for finite-difference micromagnetic simulations. The four methods implemented are twopointstencil, fivepointstencil, solidangle, and solidanglefourier. The package assumes NumPy arrays of the shape \((N_x, N_y, N_z, 3)\), where \(N_i\) are the number of cells in each direction, and the final dimension is for the three components. It is assumed that the vector field is normalised.

Contents:

• Getting Started
• API Reference