HallThruster.jl

HallThruster.jl: a Julia package for 1D Hall thruster discharge simulation - Published in JOSS (2023)

https://github.com/um-pepl/hallthruster.jl

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    3 of 9 committers (33.3%) from academic institutions
  • Institutional organization owner
    Organization um-pepl has institutional domain (pepl.engin.umich.edu)
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords from Contributors

finite-element-methods
Last synced: 6 months ago · JSON representation ·

Repository

An open-source fluid Hall thruster code

Basic Info
  • Host: GitHub
  • Owner: UM-PEPL
  • License: other
  • Language: Julia
  • Default Branch: main
  • Size: 125 MB
Statistics
  • Stars: 26
  • Watchers: 2
  • Forks: 14
  • Open Issues: 6
  • Releases: 51
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

HallThruster.jl Logo HallThruster.jl Logo

| Documentation | Build Status| Paper| Repository DOI| |:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:| | Dev | CI codecov| status | 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. HallThruster.jl has been used by professionals and student teams alike to conduct electric propulsion research. See Science highlights for a list of publications that have used HallThruster.jl.

Installation

To install HallThruster.jl, you must first install Julia 1.10 or above from the official Julia site. 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

julia (@v1.10) 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.

Changelog

[!WARNING] v0.18.0 is a breaking release, made as part of our effort to move toward v1.0.0 in the next few months. Users may need to update their code to avoid errors. Check out the list of changes and removals to see how to migrate your code.

A log of changes to the code from v0.18.0 onward can be found here.

Contribution

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!

Citation

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.

Owner

  • Name: Plasmadynamics and Electric Propulsion Laboratory
  • Login: UM-PEPL
  • Kind: organization
  • Email: pepl_webmaster@umich.edu
  • Location: United States of America

Github organization for the Plasmadynamics and Electric Propulsion Laboratory at the University of Michigan, Ann Arbor

JOSS Publication

HallThruster.jl: a Julia package for 1D Hall thruster discharge simulation
Published
June 28, 2023
Volume 8, Issue 86, Page 4672
Authors
Thomas Marks ORCID
Plasmadynamics and Electric Propulsion Laboratory, University of Michigan, Ann Arbor, USA
Paul Schedler
ETH Zurich, Zurich, Switzerland
Benjamin Jorns ORCID
Plasmadynamics and Electric Propulsion Laboratory, University of Michigan, Ann Arbor, USA
Editor
Lucy Whalley ORCID
Tags
Plasma physics Low temperature magnetized plasma CFD Hall Thruster Electric Propulsion

Citation (CITATION.bib)

@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} 
} 

GitHub Events

Total
  • Create event: 19
  • Commit comment event: 25
  • Release event: 11
  • Issues event: 6
  • Watch event: 7
  • Issue comment event: 24
  • Push event: 130
  • Pull request event: 15
  • Fork event: 4
Last Year
  • Create event: 19
  • Commit comment event: 25
  • Release event: 11
  • Issues event: 6
  • Watch event: 7
  • Issue comment event: 24
  • Push event: 130
  • Pull request event: 15
  • Fork event: 4

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,077
  • Total Committers: 9
  • Avg Commits per committer: 119.667
  • Development Distribution Score (DDS): 0.261
Past Year
  • Commits: 161
  • Committers: 3
  • Avg Commits per committer: 53.667
  • Development Distribution Score (DDS): 0.012
Top Committers
Name Email Commits
Thomas Marks m****a@u****u 796
dere4 9****4 213
Declan Brick b****d@u****u 52
Joshua Eckels 3****d 6
CompatHelper Julia c****y@j****g 5
Lucy Whalley l****y@n****k 2
juuso22 4****2 1
its-lean 1****n 1
Kyle Niemeyer k****r@f****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 20
  • Total pull requests: 83
  • Average time to close issues: 3 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 8
  • Total pull request authors: 9
  • Average comments per issue: 6.45
  • Average comments per pull request: 0.77
  • Merged pull requests: 67
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 6
  • Pull requests: 9
  • Average time to close issues: 10 days
  • Average time to close pull requests: 19 minutes
  • Issue authors: 6
  • Pull request authors: 3
  • Average comments per issue: 8.33
  • Average comments per pull request: 0.33
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • DecBrick (5)
  • archermarx (4)
  • dynamic-queries (3)
  • bboyeleven (3)
  • hmalik-p4 (1)
  • KouroshEsmaeili (1)
  • krishna123-murali (1)
  • JuliaTagBot (1)
Pull Request Authors
  • archermarx (43)
  • dere4 (19)
  • github-actions[bot] (13)
  • DecBrick (13)
  • eckelsjd (7)
  • juuso22 (2)
  • lucydot (2)
  • its-lean (1)
  • kyleniemeyer (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • julia 4 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 34
juliahub.com: HallThruster

An open-source fluid Hall thruster code

  • Versions: 34
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 4 Total
Rankings
Dependent repos count: 9.8%
Average: 23.9%
Dependent packages count: 38.1%
Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • codecov/codecov-action v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite