# Warp Factory

## Warp Factory

- [What is Warp Factory?](https://applied-physics.gitbook.io/warp-factory/what-is-warp-factory.md)
- [Installing Warp Factory](https://applied-physics.gitbook.io/warp-factory/overview/installing-warp-factory.md): How to setup and install Github, MATLAB, and Warp Factory
- [Workflow](https://applied-physics.gitbook.io/warp-factory/overview/workflow.md): How users work within Warp Factory
- [Codebase Structure](https://applied-physics.gitbook.io/warp-factory/overview/codebase-structure.md): Description of the general organization and core functions within Warp Factory
- [Object Types](https://applied-physics.gitbook.io/warp-factory/overview/object-types.md): Describes the major object types used in Warp Factory
- [Frames](https://applied-physics.gitbook.io/warp-factory/overview/frames.md): The use of frames in Warp Factory
- [Metrics](https://applied-physics.gitbook.io/warp-factory/examples/metrics.md)
- [M1 - First Metric](https://applied-physics.gitbook.io/warp-factory/examples/metrics/m1-first-metric.md)
- [M2 - Default Metrics](https://applied-physics.gitbook.io/warp-factory/examples/metrics/m2-default-metrics.md)
- [M3 - Building a Metric](https://applied-physics.gitbook.io/warp-factory/examples/metrics/m3-building-a-metric.md)
- [Energy Tensor](https://applied-physics.gitbook.io/warp-factory/examples/energy-tensor.md)
- [T1 - First Energy Tensor](https://applied-physics.gitbook.io/warp-factory/examples/energy-tensor/t1-first-energy-tensor.md)
- [T2 - Cartoon Methods](https://applied-physics.gitbook.io/warp-factory/examples/energy-tensor/t2-cartoon-methods.md)
- [T3 - GPU Computation](https://applied-physics.gitbook.io/warp-factory/examples/energy-tensor/t3-gpu-computation.md)
- [T4 - Solver Order](https://applied-physics.gitbook.io/warp-factory/examples/energy-tensor/t4-solver-order.md)
- [T5 - Errors](https://applied-physics.gitbook.io/warp-factory/examples/energy-tensor/t5-errors.md)
- [Analysis](https://applied-physics.gitbook.io/warp-factory/examples/analysis.md)
- [A1 - Energy Conditions](https://applied-physics.gitbook.io/warp-factory/examples/analysis/a1-energy-conditions.md)
- [A2 - Metric Scalars](https://applied-physics.gitbook.io/warp-factory/examples/analysis/a2-metric-scalars.md)
- [A3 - Eval Metric](https://applied-physics.gitbook.io/warp-factory/examples/analysis/a3-eval-metric.md)
- [A4 - Momentum Flow](https://applied-physics.gitbook.io/warp-factory/examples/analysis/a4-momentum-flow.md)
- [Warp Shell](https://applied-physics.gitbook.io/warp-factory/examples/warp-shell.md)
- [W1 Warp Shell Comoving](https://applied-physics.gitbook.io/warp-factory/examples/warp-shell/w1-warp-shell-comoving.md)
- [Metrics Module](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module.md)
- [Metric Library](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library.md)
- [metricGet\_Minkowski](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_minkowski.md)
- [metricGet\_Alcubierre](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_alcubierre.md): Standard Alcubierre metric setup
- [metricGet\_Lentz](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_lentz.md): Lentz warp solution implementation
- [metricGet\_VanDenBroeck](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_vandenbroeck.md)
- [metricGet\_WarpShellComoving](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_warpshellcomoving.md)
- [metricGet\_ModifiedTime](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_modifiedtime.md)
- [metricGet\_Schwarzschild](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-library/metricget_schwarzschild.md)
- [Metric Functions](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-functions.md): Creation and library of standard metrics in Warp Factory
- [setMinkowski](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-functions/setminkowski.md)
- [setMinkowskiThreePlusOne](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-functions/setminkowskithreeplusone.md)
- [threePlusOneBuilder](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-functions/threeplusonebuilder.md): Constructing a metric tensor from its 3+1 components.
- [threePlusOneDecomposer](https://applied-physics.gitbook.io/warp-factory/modules/metrics-module/metric-functions/threeplusonedecomposer.md): Finds the 3+1 foliation components from a metric tensor.
- [Analyzer Module](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module.md)
- [getMomentumFlowLines](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module/getmomentumflowlines.md)
- [doFrameTransfer](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module/doframetransfer.md)
- [changeTensorIndex](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module/changetensorindex.md)
- [getScalars](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module/getscalars.md)
- [getEnergyConditions](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module/getenergyconditions.md)
- [evalMetric](https://applied-physics.gitbook.io/warp-factory/modules/analyzer-module/evalmetric.md)
- [Solver Module](https://applied-physics.gitbook.io/warp-factory/modules/solver-module.md)
- [getEnergyTensor](https://applied-physics.gitbook.io/warp-factory/modules/solver-module/getenergytensor.md)
- [verifyTensor](https://applied-physics.gitbook.io/warp-factory/modules/solver-module/verifytensor.md)
- [Visualizer Module](https://applied-physics.gitbook.io/warp-factory/modules/visualizer-module.md)
- [plotThreePlusOne](https://applied-physics.gitbook.io/warp-factory/modules/visualizer-module/plotthreeplusone.md)
- [plotTensor](https://applied-physics.gitbook.io/warp-factory/modules/visualizer-module/plottensor.md)
- [Plot Functions](https://applied-physics.gitbook.io/warp-factory/modules/visualizer-module/plot-functions.md)
- [Units Module](https://applied-physics.gitbook.io/warp-factory/modules/units-module.md)
- [Contributing](https://applied-physics.gitbook.io/warp-factory/general/contributing.md)
- [FAQ](https://applied-physics.gitbook.io/warp-factory/general/faq.md): List of common asked questions about Warp Factory
- [Citing Warp Factory](https://applied-physics.gitbook.io/warp-factory/general/citing-warp-factory.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://applied-physics.gitbook.io/warp-factory/what-is-warp-factory.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.