Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

brought in text from manuscript to statement of need in readme #34

Merged
merged 2 commits into from
May 21, 2020
Merged

brought in text from manuscript to statement of need in readme #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6a626a
brought in text from manuscript to statement of need in readme
joglekara May 20, 2020
84ac431
changed header "level"
joglekara May 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,17 @@ To start the MLFlow UI server, type ``mlflow ui`` into the terminal and then nav

## Overview
VlaPy is a 1-spatial-dimension, 1-velocity-dimension, Vlasov-Poisson-Fokker-Planck code written in Python.
The Vlasov-Poisson-Fokker-Planck system of equations is commonly used in plasma physics.

## Statement of Need
There are many software libraries that solve the same equation set which are available in academic settings,
research laboratories, and industry, but the community has yet to benefit from a simple-to-read, open-source Python
implementation. This lack of capability is currently echoed in conversations within the ``PlasmaPy`` community
(``PlasmaPy`` is a collection of open-source plasma physics resources).
Our aim with ``VlaPy`` is to take a step towards filling this need in the open-source community.

``VlaPy`` is intended to help students and researchers learn about and explore concepts in fundamental plasma and fluid
physics and numerical methods. It is also designed to provide a science-accessible introduction to industry and
software engineering best-practices, including unit and integrated testing, and extensible and maintainable code.

## Implementation
The Vlasov-Poisson-Fokker-Planck system can be decomposed into 4 components.
Expand Down Expand Up @@ -82,6 +92,5 @@ significantly eases the physicist's workflow.
There are more details about how the diagnostics for a particular type of simulation are packaged and provided to
the run manager object. These will be described in time. One can infer these from the code as well.


## Contributing to VlaPy
Please see the guide in [contribution guidelines for this project](CONTRIBUTING.md)