Skip to content

Installation

These videos document a very basic environment setup for working with FiQuS. First all the needed software is installed and then last video shows how to run a simple FiQuS model.
It is done with Windows 11 and PyCharm. Windows 10 works in the same way. An equivalent setup for Visual Studio Code would also work.

1. Python installation

This video shows how to install Python (3.11.8).
Link to: python.org
Direct download of Python 3.11.8 64-bit: Windows installer (64-bit)

2. PyCharm installation

This video shows how to install PyCharm (2024.2.3).
Link to: jetbrains.com/pycharm
Direct download of PyCharm 64-bit: .exe (Windows)

3. Git installation

This video shows how to install Git (2.46.2).
Link to: git-scm.com
Direct download of PyCharm 64-bit: 64-bit Git for Windows Setup

4. FiQuS installation

This video shows how to install (git clone) FiQuS from CERN Gitlab repository.
Link to: cern.ch/fiqus
Direct repository link: gitlab.cern.ch/steam/fiqus
Clone with HTTPS link: https://gitlab.cern.ch/steam/fiqus.git

5. CERNGetDP installation

This video shows how to download CERNGetDP from CERN Gitlab repository and how to set settings in FiQuS for the executable location.
Link to: cern.ch/cerngetdp
Direct repository link: gitlab.cern.ch/steam/cerngetdp
Direct download link CERNGetDP(2024.8.2): cerngetdp_2024.8.2.zip

6. Gmsh installation

This video shows how to download Gmsh and what to do afterwards.
Link to: gmsh.info
Direct download link Gmsh(4.13.1): gmsh-4.13.1-Windows64.zip

7. FiQuS run

This video shows how to run a FiQuS. The code used in the video is below. Video also shows how to set up Gmsh to open geometry, mesh and result files.

import os
from fiqus import MainFiQuS as mf

magnet_name = 'MQXA'

input_file = os.path.join(os.getcwd(), 'tests', '_inputs', magnet_name, f'{magnet_name}.yaml')
output_folder = os.path.join(os.getcwd(), 'tests', '_outputs', magnet_name)

mf.MainFiQuS(input_file_path=input_file, model_folder=output_folder)

Last update: October 7, 2024