# zapdos

**Repository Path**: KIDXT/zapdos

## Basic Information

- **Project Name**: zapdos
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: LGPL-2.1
- **Default Branch**: devel
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-01-03
- **Last Updated**: 2025-01-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.801834.svg)](https://doi.org/10.5281/zenodo.801834)

[![Website Status](https://github.com/shannon-lab/zapdos/actions/workflows/generate_website.yml/badge.svg)](https://github.com/shannon-lab/zapdos/actions/workflows/generate_website.yml)

[![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/shannonlab/zapdos/latest?color=green&label=docker%20latest&logo=docker&logoColor=white)](https://hub.docker.com/r/shannonlab/zapdos)

# Zapdos

Free (in all senses of the word) and open source software for modeling plasmas using finite elements. This application is built on top of [the MOOSE Framework](https://mooseframework.inl.gov).

## Documentation

For Zapdos documentation, there are two websites available:

- https://shannon-lab.github.io/zapdos - the main Zapdos website, for source code documentation and general info.
- https://mooseframework.inl.gov - for information on the underpinnings of Zapdos and other available resources from MOOSE.

Alternatively, there are three main pieces of file-based documentation for Zapdos, all located in the `doc` directory:

- `Zapdos_Tutorial.pdf` - A general tutorial of Zapdos capabilities, with explanations of the finite element method, code and input file structure, the Peacock GUI (from MOOSE), and examples of usage.
- `Chemical_Reactions.ipynb` - A Jupiter notebook containing notes on understanding existing chemistry kernels and/or implementing new ones in Zapdos/MOOSE.
- `Lindsay_thesis_coupling_of_plasmas_and_liquids.pdf` - Chapter 3 of the original PhD dissertation introducing Zapdos ("Coupling of Plasmas and Liquids" by Alex Lindsay).

## Getting Started

- [Installation](https://shannon-lab.github.io/zapdos/getting_started/installation.html)
- [Running a Zapdos input file](https://shannon-lab.github.io/zapdos/getting_started/using_zapdos.html)
- [Meshing](https://shannon-lab.github.io/zapdos/getting_started/zapdos_meshing.html)

## Questions? Issues? Want to Contribute?

Please do not hesitate to contact the [Zapdos GitHub Discussions page](https://github.com/shannon-lab/zapdos/discussions) if you have any questions about using or contributing to this software.