This package simulates magnetic fields using the magpylib library.
These instructions assume you've installed anaconda. I also recommend the pycharm community IDE for editing and debugging python code. The instructions also assume that you know how to use the command line "cd" command to change directory.
Open a terminal (git bash if using windows, terminal on mac or linux). Navigate to the parent folder where you store your git repositories using the 'cd' command in the terminal. Once there clone the repository and cd into it.
git clone https://github.com/qt3uw/qt3magnetdesigns.git
cd qt3magnetdesigns
You can use the .yml file contained in the repository to set up an anaconda environment with the required packages using the following command (if you are in windows, you will need to switch from the git bash terminal to the "anaconda prompt" terminal that can be found in start menu if you've installed anaconda, on a mac or linux you can use the good old terminal for everything):
conda env create -f qt3magnetdesigns.yml
This creates an anaconda environment called "qt3magneticdesigns", which contains all of the dependencies of this repository. You can activate that environment with the following command:
conda activate qt3magnetdesigns
Once activated your terminal will usually show (qt3magneticdesigns) to the left of the command prompt.
Now that your terminal has activated the anaconda environment you can use pip to install this package in that environment. cd into the parent folder that contains the qt3magnetdesigns repository you cloned earlier. Then use the following command to install the repository into the qt3magneticdesigns conda environment.
pip install -e qt3magnetdesigns
At this point is complete. If using an IDE, like pycharm, you will need to make sure that the python interpreter for your project is set to the python.exe file for the anaconda environment that you just created. An easy way to find the path to that python executable within the environment is to use the following command in a terminal where the qt3magneticdesigns enviornment is activated:
where python
On my windows machine in an anaconda prompt this command returns the following (the command itself is the top line):
(qt3magnetdesigns) C:\Users\mfpars\repos>where python
C:\Users\mfpars\anaconda3\envs\qt3magnetdesigns\python.exe
C:\Users\mfpars\AppData\Local\Microsoft\WindowsApps\python.exe
The path that we want is the middle line. If using pycharm, follow these instructions to set your interpereter to that path.