This repository is an active work in progress. It represents a core set of functionalities that were submitted as an early-release version for the RMIT Early Entry application. The code is currently being refactored from v1.3-dev to release and is also expanded upon.

This package serves to explore linear motor designs quickly, providing easy integration for optimizers. It targets applications such as 3D printers, pick-and-place machines, laser cutters, and other electromechanical systems.

This initial release supports FEMM (Finite Element Method Magnetics) as the primary solver and renderer. Planned future releases will expand support to include additional solvers.

A full example of a magnetic simulation of a tubular linear motor is available in the repository: examples/tubular/simulate.py

1. Install FEMM
   (Windows Only) FEMM (Finite Element Method Magnetics) is a free, open-source tool for low-frequency electromagnetic simulations, ideal for motor design.

   Download and install FEMM from the official website:
   https://www.femm.info/wiki/HomePage

   Ensure FEMM is added to your system PATH or installed in the default location (usually C:\femm42 on Windows) so the simulator can call it without issues.

2. Install BlueShark
   Clone the repository and install the package locally in editable mode:

   git clone https://github.com/wgbowley/blueshark.git
   cd blueshark
   pip install -e .

This section is under development. A detailed usage example will be provided here soon.