Documentation	Build Status	Paper	Repository DOI

HallThruster.jl is an open-source, 1D fluid Hall thruster code written in Julia. It is developed by Thomas Marks, Paul Schedler and Declan Brick at the University of Michigan's Plasmadynamics and Electric Propulsion Laboratory and is licensed under the MIT license.

To install HallThruster.jl, you must first install Julia 1.7 or above from the official Julia site, or by using juliaup. We recommend using the latest Julia release when possible. Once installed, launch Julia and type ] to enter the Pkg REPL. To install HallThruster.jl type

(@v1.9) pkg> add https://github.com/UM-PEPL/HallThruster.jl

This will install HallThruster.jl using Julia's package manager. For details on setting up and running Hall thruster simulations, see the official documentation. A Tutorial is available here.

Users are welcome to suggest and implement features for the code, as well as report bugs or numerical issues they encounter. Please feel free to open an issue on this repository describing your desired change/bug-fix. Pull requests are also welcome!

If you use this code in your work, please cite our publication in the Journal of Open Source Software:

@article{Marks2023, 
  doi = {10.21105/joss.04672},
  url = {https://doi.org/10.21105/joss.04672},
  year = {2023},
  publisher = {The Open Journal},
  volume = {8}, number = {86}, pages = {4672},
  author = {Thomas Marks and Paul Schedler and Benjamin Jorns},
  title = {HallThruster.jl: a Julia package for 1D Hall thruster discharge simulation},
  journal = {Journal of Open Source Software} 
} 

This BibTEX entry can also be found in CITATION.bib.