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
  • Move and Rotate
• Field Computation (B, H, J, M)
  • Object-oriented Interface
  • Functional Interface
  • Core Interface
  • Computation Workflow (B, H, J, M)
• Force Computation (F, T)
  • Computation Idea
  • Force Interface
• Graphic output
  • 3D View
  • 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
  • Pixel Field

Resources

• Physics and Computation
• Examples