Skip to content

Commit

Permalink
doc: add feature
Browse files Browse the repository at this point in the history
  • Loading branch information
Beforerr committed Jan 12, 2025
1 parent 6e8c22a commit 0d4e2c1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ CurrentModule = PlasmaFormulary
A Julia package for plasma physics formulas.
This package implements a subset of the formulas found in the [NRL Plasma Formulary](https://www.nrl.navy.mil/News-Media/Publications/NRL-Plasma-Formulary/), as well as some additional formulas taken from the [PlasmaPy](https://docs.plasmapy.org) project.

In the future, the package will support providing particle properties using the [ChargedParticles.jl](https://github.com/Beforerr/ChargedParticles.jl) package.
## Features

- For functions that take a `ParticleLike` as an argument, we use [ChargedParticles.jl](https://github.com/Beforerr/ChargedParticles.jl) package to handle particle properties. One could provide a symbolic particle name or string or a Particle object for the argument. In addition, mass number and charge number can be specified as keyword arguments for these functions.
- For function whose arguments are `Unitful` quantities with unique dimensions, arguments are order independent (see [PermuteArgs.jl](https://github.com/Beforerr/PermuteArgs.jl)).

## Quick Example

Expand Down

0 comments on commit 0d4e2c1

Please sign in to comment.