# piclas

**Repository Path**: mxlio/piclas

## Basic Information

- **Project Name**: piclas
- **Description**: PICLas is a parallel, three-dimensional PIC-DSMC solver developed cooperatively by the Institute of Space Systems, Institute of Aerodynamics and Gas Dynamics at the University of Stuttgart and the spin-off boltzplatz. PICLas is a flexible particle-based plasma simulation suite.
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Welcome to PICLas

The code is licensed under the GNU General Public License V3. The licence can be found in [LICENCE](LICENCE.md) and the list of contributors in [CONTRIBUTORS](CONTRIBUTORS.md).

## PICLas Documentation

The documentation is a work in progress. For an installation guide please refer to the documentation.

1. [Introduction](doc/userguide/000_userguide.md)
2. [Installation](doc/userguide/010_installation.md)
3. [Workflow](doc/userguide/020_workflow.md)
4. [Features & Models](doc/userguide/030_features_models.md)
5. [Visualization & Output](doc/userguide/040_visu_output.md)
6. [Tools](doc/userguide/050_tools.md)
7. [Tutorials](doc/userguide/060_tutorials.md)
8. [Development Guide](doc/userguide/080_cluster_guide.md)

A PDF file can be generated simply by executing *make* in the *doc/userguide/* folder. This requires `pandoc`, `pandoc-citeproc` and `LaTeX`. More information about pandoc and its installation can be found [here](https://pandoc.org/installing.html).

The tools are known to work with the following software versions:

* OpenMPI > 1.8
* HDF5 > 1.8.13
* CMake > 3.0.0

## Regression Testing

For information about the regression testing see [REGGIE](REGGIE.md).

## Used libraries

PICLas uses several external libraries as well as auxilliary functions from open source projects, including:

* [HDF5](https://www.hdfgroup.org/)
* [MPI](http://www.mcs.anl.gov/research/projects/mpi/)
* [LAPACK](http://www.netlib.org/lapack/)
* [cmake](https://www.cmake.org)

## I need help or further information:

* [IAG - Numerics Research Group](https://nrg.iag.uni-stuttgart.de/)
* [IRS - Numerical Modelling and Simulation Group](https://www.irs.uni-stuttgart.de/forschung/numerische_modellierung_und_simulation/PICLas.en.html)
* [HOPR (High Order Preprocessor)](https://hopr-project.org)
* [boltzplatz - Numerical Plasma Dynamics](https://www.boltzplatz.eu)