README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# WarpX

[![Code Status master](https://img.shields.io/travis/ECP-WarpX/WarpX/master.svg?label=master)](https://travis-ci.org/ECP-WarpX/WarpX/branches)
[![Code Status dev](https://img.shields.io/travis/ECP-WarpX/WarpX/dev.svg?label=dev)](https://travis-ci.org/ECP-WarpX/WarpX/branches)
[![Documentation Status](https://readthedocs.org/projects/warpx/badge/?version=latest)](https://warpx.readthedocs.io/en/latest/?badge=latest)
[![GitHub commits since last release](https://img.shields.io/github/commits-since/ECP-WarpX/WarpX/latest/dev.svg)](https://github.com/ECP-WarpX/WarpX/compare/master...dev)
[![Language](https://img.shields.io/badge/language-C%2B%2B11-orange.svg)](https://isocpp.org/)
[![Development Status](https://img.shields.io/badge/development%20status-alpha-orange.svg)]()  
[![Gitter](https://badges.gitter.im/ECP-WarpX/community.svg)](https://gitter.im/ECP-WarpX/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![License WarpX](https://img.shields.io/badge/license-BSD--3--Clause--LBNL-blue.svg)](https://spdx.org/licenses/BSD-3-Clause-LBNL.html)
[![DOI](https://img.shields.io/badge/DOI-10.1016/j.nima.2018.01.035-blue.svg)](https://doi.org/10.1016/j.nima.2018.01.035)

## 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://warpx.readthedocs.io

To contact the developers, feel free to open an issue on this repo, or visit our Gitter room at https://gitter.im/ECP-WarpX/community

## Contributing

Our workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md).