Getting Started on Mac

Getting the MieSimulatorGUI App from GitHub:

MacOS App (.app)

• Download the latest "MieSimulatorGUI_vX_XX.app.zip" file.
• Double-click the file to open the application.
• If a warning appears stating the developer can't be verified, go to System Settings > Security & Privacy and click Open Anyway to continue.

MacOS DiskImage (.dmg)

• Download the latest "MieSimulatorGUI_vX_XX.dmg" file.
• Double-click the file to mount the disk image.
• A disk image icon will appear on your desktop. Double-click it to open the folder and click on "MieSimulatorGUI_vX_XX".
• If a warning appears stating the developer can't be verified, go to System Settings > Security & Privacy and click Open Anyway to continue.

Getting the MieSimulatorGUI Source Code from GitHub:

Installing Prerequisites

• Install Xcode: Follow the instructions provided on the Qt for macOS page to install and configure Xcode correctly.
• Download Qt 6: Visit the Qt download page and select the version compatible with environment.
• Run the Installer: Follow the setup prompts to install Qt 6. Ensure that the Qt Creator IDE is selected during the installation process.
• Obtain the Source Code: Use one of the following two methods:
  • git Clone: Clone the source code from GitHub using the command: git clone https://github.com/VirtualPhotonics/MieSimulatorGUI.git. This will create a 'MieSimulatorGUI' directory in your current location.
  • ZIP Download: Navigate to the GitHub repository and select Code > Download ZIP. Extract the files to your preferred directory.

Building the Project

• Launch Qt Creator and open the "MieSimulatorGUI.pro" file.
• In the next window, select proper project kit and click Configure Project.
• Select Build > Run qmake, and then select Build > Build Project "MieSimulatorGUI" or press Cmd+B.

Running Tests and the Application

• To run tests: Select Tools > Tests > Run All Tests.
• To run the application: Select Build > Run or press Cmd+R.

Building and Running Tests from the Command Line

• Open Terminal
• From the root directory of the project (where MieSimulatorGUI.pro is located), run the following commands:

chmod +x MieSimulatorGUI.pro
mkdir -p build
cd build
qmake ../MieSimulatorGUI.pro
make -j$(nproc)
cd test
chmod +x MieSimulatorGUI_test
./MieSimulatorGUI_test

Note:
- If you get any errors, check whether Qt and its debugger is working properly (Generate a sample Qt program and run).