User Guide

The user guide provides detailed descriptions of the Magpylib API with many interactive examples to help users along the way.

Getting Started

• Installation and Dependencies
  • Dependencies and Synergies
  • Installation
• The Magpylib fundamentals
  • Basic features
  • Advanced features

Documentation

• Units and Types
  • Units
  • Arbitrary unit Convention
  • Types
• The Magpylib Classes
  • Base properties
  • Local and global coordinates
  • Magnet classes
  • Current classes
  • Miscellaneous classes
  • Sensor
  • Collection
• Position, Orientation, and Paths
  • Position and orientation attributes
  • Move and Rotate
• Field Computation
  • Object-oriented interface
  • Functional interface
  • Core interface
  • Field computation workflow
• Graphic output
  • 3D graphics with show
  • Graphic backends
  • Plotting canvas
  • Return figure
  • Animation
  • Built-in Subplots
• Graphic styles
  • Default style
  • Magic underscore notation
  • Individual style
  • Collection style
  • Local style override
  • List of style properties
  • Custom 3D models
  • Pre-defined 3D models
  • Adding a CAD model
• Magpylib Force v0.3.1
  • Installation
  • API
  • Computation details

Resources

• Physics and Computation
  • What is implemented ?
  • The analytical solutions
  • Accuracy of the Solutions and Demagnetization
  • Computation Performance
  • Numerical stability
• Examples
  • Tutorials
  • Visualizations
  • Complex Magnet Shapes
  • Miscellaneous
  • Applications
  • Magpylib-Force