Warp Factory
  • What is Warp Factory?
  • Overview
    • Installing Warp Factory
    • Workflow
    • Codebase Structure
    • Object Types
    • Frames
  • Examples
    • Metrics
      • M1 - First Metric
      • M2 - Default Metrics
      • M3 - Building a Metric
    • Energy Tensor
      • T1 - First Energy Tensor
      • T2 - Cartoon Methods
      • T3 - GPU Computation
      • T4 - Solver Order
      • T5 - Errors
    • Analysis
      • A1 - Energy Conditions
      • A2 - Metric Scalars
      • A3 - Eval Metric
      • A4 - Momentum Flow
    • Warp Shell
      • W1 Warp Shell Comoving
  • Modules
    • Metrics Module
      • Metric Library
        • metricGet_Minkowski
        • metricGet_Alcubierre
        • metricGet_Lentz
        • metricGet_VanDenBroeck
        • metricGet_WarpShellComoving
        • metricGet_ModifiedTime
        • metricGet_Schwarzschild
      • Metric Functions
        • setMinkowski
        • setMinkowskiThreePlusOne
        • threePlusOneBuilder
        • threePlusOneDecomposer
    • Analyzer Module
      • getMomentumFlowLines
      • doFrameTransfer
      • changeTensorIndex
      • getScalars
      • getEnergyConditions
      • evalMetric
    • Solver Module
      • getEnergyTensor
      • verifyTensor
    • Visualizer Module
      • plotThreePlusOne
      • plotTensor
      • Plot Functions
    • Units Module
  • General
    • Contributing
    • FAQ
    • Citing Warp Factory
Powered by GitBook
On this page
  1. Overview

Installing Warp Factory

How to setup and install Github, MATLAB, and Warp Factory

PreviousWhat is Warp Factory?NextWorkflow

Last updated 1 year ago

This guide will walk you through the process of setting up Warp Factory, including the installation of git, the installation of MATLAB, and the installation of the Parallel Computing Toolbox.

Download and Install Git

  1. Visit the Git website () and download the appropriate installer for your operating system.

  2. Run the installer and follow the on-screen instructions to complete the installation process.

Download and install MATLAB

  1. Visit the MATLAB website () and sign in or create a MathWorks account.

  2. Download the MATLAB installer for your operating system.

  3. During the MATLAB installation process, when prompted to select components, check the box next to "Parallel Computing Toolbox". If you've already installed MATLAB, open MATLAB, navigate to the "Home" tab, click "Add-Ons" and then "Get Add-Ons". Search for "Parallel Computing Toolbox" and follow the on-screen instructions to install it.

  4. Run the installer and follow the on-screen instructions to complete the installation process. Ensure that you have an active MATLAB license during this step.

Clone Warp Factory from GitHub using MATLAB's Source Control Functionality

  1. Visit the and click the green "Code" button and copy the clone URL.

  2. Launch MATLAB.

  3. In the MATLAB "Home" tab, click on "New" and select "Project -> From Git".

  4. Paste the clone URL you copied in step a into the "Repository path" field.

  5. Choose a local folder to store the project files in the "Sandbox" field.

  6. Click "Retrieve" to clone the project files to the specified local folder.

Add All Folders and Subfolders to the MATLAB Path:

  1. In MATLAB, go to the "Home" tab and click on "Set Path".

  2. Click on "Add with Subfolders", select the cloned project folder, and click "OK" to add all the folders and subfolders to the MATLAB path.

  3. Click "Save" and then "Close" to save the changes to the MATLAB path.

Congratulations! You have successfully installed and set up Warp Factory.

Required MATLAB packages

  • Parallel Computing Toolbox

https://git-scm.com/
https://www.mathworks.com/products/matlab.html
GitHub repository for Warp Factory