2. Installation

Note: Ensure that you have the necessary permissions to install packages on your system. Consider using a Python virtual environment to manage your dependencies.

To use pyCoilGen, you need to:

Optionally, you can install:

2.1. Install Python

pyCoilGen depends on Python >= 3.6.

Please follow the instructions for your operating system to install Python.

2.2. Install pyCoilGen

To install pyCoilGen, you can use pip, the Python package manager.

$ pip install pycoilgen

2.3. SciPy Installation Issues on Linux

Some Linux users have reported issues when installing SciPy. In order to complete the SciPy installation, it was necessary to install BLAS and gfortran.

$ sudo apt-get install libopenblas-dev gfortran

2.4. Optional packages

2.4.1. Install pyCoilGen Data Package

There is an optional data package for pyCoilGen that provides 34 mesh .stl files of various shapes and sizes, one pre-calculated target field and two pre-optimised solutions. This package can be installed with pip.

$ pip install pycoilgen_data 

These files will be automatically detected by pyCoilGen.

2.4.2. FastHenry2

The FastHenry2 application is used to calculate the resistance and inductance of the coil winding. If these values are important to your coil project, this application must be downloaded and installed.

2.4.2.1. Windows

Go to the download page, fill out the form, and then download and install the FastFieldSolvers bundle, e.g. FastFieldSolvers Software Bundle Version 5.2.0.

2.4.2.2. Linux

Clone the FastHenry2 repository from GitHub and compile it:

$ git clone https://github.com/ediloren/FastHenry2.git
$ cd FastHenry2/src
$ make

Thereafter you can manually copy the binary executable file bin/fasthenry to the /usr/bin directory or use it in place by setting the fasthenry_bin configuration parameter to the location of the binary.