README.md

WarpX

Overview

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

WarpX is a highly-parallel and highly-optimized code, which can run on GPUs and multi-core CPUs, and includes load balancing capabilities. WarpX scales to the world's largest supercomputers and was awarded the 2022 ACM Gordon Bell Prize.

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 discussions page at https://github.com/ECP-WarpX/WarpX/discussions

Contributing

Our workflow is described in CONTRIBUTING.rst. We invite you to contribute to WarpX in any form following our Code of Conduct, e.g., contribute to discussions, help each other in issues, fix bugs, or add documentation and new functionality!

Governance

WarpX is hosted by the High Performance Computing Foundation (HPSF). If your organization wants to help steer the evolution of the HPC software ecosystem, visit hpsf.io and consider joining!

The WarpX open governance model is described in GOVERNANCE.rst.

Copyright Notice

WarpX Copyright (c) 2018, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Innovation & Partnerships Office at IPO@lbl.gov.

Please see the full license agreement in LICENSE.txt. Please see the notices in NOTICE.txt. The SPDX license identifier is BSD-3-Clause-LBNL.