Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
egavazzi authored Dec 13, 2024
1 parent dbc30cd commit 2cfb918
Showing 1 changed file with 9 additions and 20 deletions.
29 changes: 9 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,23 @@
|:---------------------------------:|:-----------------------:|
| [![][docs-dev-img]][docs-dev-url] | [![][doi-img]][doi-url] |

This is a julia implementation of the following time-dependent model of electron transport in the ionosphere :
https://github.com/egavazzi/AURORA
AURORA is a time-dependent multi-stream electron transport code, suitable for modeling ionospheric electron-fluxes during periods of rapidly varying electron-precipitation.


This is a Julia implementation of the original AURORA code written in MATLAB and available at https://github.com/egavazzi/AURORA. The version present here is the one we recommend to use. It is in active development, is faster (~1000x), and produces more accurate results (i.e. bugs have been fixed).

## Installation

1. Clone the repository (e.g. with Git) or download and extract the .zip (available under the green _**code**_ button)

2. Open a terminal, **go in the folder where the code is installed**, and start Julia with the command:
```
$> julia
```

3. Then, **activate** the repository and download the packages required by *AURORA.jl* using the commands:
```julia-repl
julia> using Pkg
julia> Pkg.activate(".")
julia> Pkg.instantiate()
```

4. *AURORA.jl* is now ready to use!

Descriptions of the code are available in Gustavsson (2022) and Gavazzi (2022).

## Installation
Instructions are available in the documentation.

## Documentation
The documentation is available [**here**](https://egavazzi.github.io/AURORA.jl/dev/).

## References
Gavazzi, E. (2022). The effects of time-variation of electron fluxes from the auroral ionosphere on M-I coupling [Master thesis, UiT Norges arktiske universitet]. https://munin.uit.no/handle/10037/25897

Gustavsson, B. (2022). Time-Dependent Electron Transport I: Modelling of Supra-Thermal Electron Bursts Modulated at 5–10 Hz With Implications for Flickering Aurora. Journal of Geophysical Research: Space Physics, 127(6), e2019JA027608. https://doi.org/10.1029/2019JA027608



Expand Down

0 comments on commit 2cfb918

Please sign in to comment.