aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 259408926aaa2a477c9bc8642390b83216ef4ec8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# WarpX

## Overview

**Warning: This is an alpha release of WarpX. The code is still in active development. Robustness and performance may fluctuate at this stage. The input and output formats may evolve.**

WarpX is an advanced electromagnetic Particle-In-Cell code.
It supports many features including Perfectly-Matched Layers (PML), mesh refinement, and the boosted-frame technique.

## Documentation

In order to learn how to install and run the code, please see the online documentation: https://ecp-warpx.github.io/index.html

## Contributing

Our workflow is described in CONTRIBUTING.md.