Skip to content

Commit ec70915

Browse files
tristanmontoyabenegeeranocha
authored
Revise installation instructions (#138)
* Revise installation instructions for TrixiAtmo.jl Updated README to reflect that TrixiAtmo.jl is now a registered Julia package and modified installation instructions accordingly. * uncomment link to stable docs * remove alpha warning * add zenodo file * zenodo DOI (draft!) * Revert "add zenodo file" This reverts commit cd33197. * update authors list --------- Co-authored-by: Benedict <135045760+benegee@users.noreply.github.com> Co-authored-by: Hendrik Ranocha <ranocha@users.noreply.github.com>
1 parent cd6cd48 commit ec70915

File tree

2 files changed

+36
-19
lines changed

2 files changed

+36
-19
lines changed

AUTHORS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,14 @@ file.
77

88
* Marco Artiano
99
* Arpit Babbar
10+
* Daniel Döhring
11+
* Gregor Gassner
1012
* Benedict Geihe
1113
* Fabian Höck
1214
* Oswald Knoth
13-
* Andrés Rueda-Ramírez
15+
* Joshua Lampert
1416
* Tristan Montoya
1517
* Hendrik Ranocha
18+
* Andrés Rueda-Ramírez
1619
* Michael Schlottke-Lakemper
1720
* Andrew Winters

README.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
# 🌎 TrixiAtmo.jl 🌍
22

3-
<!-- [![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://trixi-framework.github.io/TrixiAtmo.jl/stable) -->
3+
[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://trixi-framework.github.io/TrixiAtmo.jl/stable)
44
[![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://trixi-framework.github.io/TrixiAtmo.jl/dev)
55
[![Slack](https://img.shields.io/badge/chat-slack-e01e5a)](https://join.slack.com/t/trixi-framework/shared_invite/zt-sgkc6ppw-6OXJqZAD5SPjBYqLd8MU~g)
66
[![Build Status](https://github.com/trixi-framework/TrixiAtmo.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/trixi-framework/TrixiAtmo.jl/actions?query=workflow%3ACI)
77
[![Codecov](https://codecov.io/gh/trixi-framework/TrixiAtmo.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/trixi-framework/TrixiAtmo.jl)
88
[![Coveralls](https://coveralls.io/repos/github/trixi-framework/TrixiAtmo.jl/badge.svg?branch=main)](https://coveralls.io/github/trixi-framework/TrixiAtmo.jl?branch=main)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)
10-
<!-- [![DOI](https://zenodo.org/badge/DOI/TODO.svg)](https://doi.org/TODO) -->
10+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18297711.svg)](https://doi.org/10.5281/zenodo.18297711)
1111

1212
<p align="center">
1313
<img width="60%" src="https://trixi-framework.github.io/assets/logo_atmo.png">
1414
</p>
1515

16-
**Note: This repository is still in its alpha stage and anything might change at
17-
any time and without warning.**
18-
1916
**TrixiAtmo.jl** is a numerical simulation package focused on atmospheric flows. It builds
2017
upon [Trixi.jl](https://github.com/trixi-framework/Trixi.jl), a generic flow solver for
2118
conservation laws, implementing discontinuous Galerkin methods and written in Julia.
@@ -33,24 +30,19 @@ If you have not yet installed Julia, please [follow the instructions for your
3330
operating system](https://julialang.org/downloads/platform/). TrixiAtmo.jl works
3431
with Julia v1.10 and newer. We recommend using the latest stable release of Julia.
3532

36-
TrixiAtmo.jl is **not** a registered Julia package yet, and therefore needs to be
37-
downloaded manually and then run from within the cloned directory:
38-
```bash
39-
git clone https://github.com/trixi-framework/TrixiAtmo.jl.git
40-
julia --project=@.
41-
```
42-
In addition, TrixiAtmo.jl requires the numerical solver framework
43-
[Trixi.jl](https://github.com/trixi-framework/Trixi.jl), relevant sub-packages of
44-
[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) for time integration, and
45-
[Plots.jl](https://github.com/JuliaPlots/Plots.jl) for visualization, which can be
46-
installed by executing the following in the Julia REPL:
33+
TrixiAtmo.jl is a registered Julia package and can be installed using Julia's package manager.
34+
In addition, TrixiAtmo.jl requires the numerical solver framework
35+
[Trixi.jl](https://github.com/trixi-framework/Trixi.jl) as well as relevant sub-packages of
36+
[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) for time integration. Executing the
37+
following in the Julia REPL will install the packages required to run the cases in the `examples`
38+
directory, along with [Trixi2Vtk.jl](https://github.com/trixi-framework/Trixi2Vtk.jl), which enables
39+
visualization of the resulting HDF5-based output files:
4740
```julia
4841
julia> using Pkg
4942

50-
julia> Pkg.add(["Trixi", "Trixi2Vtk", "OrdinaryDiffEqLowStorageRK", "OrdinaryDiffEqSSPRK", "Plots"])
43+
julia> Pkg.add(["TrixiAtmo", "Trixi", "OrdinaryDiffEqLowStorageRK", "OrdinaryDiffEqSSPRK", "Trixi2Vtk"])
5144
```
5245

53-
5446
## Usage
5547

5648
In the Julia REPL, first load the package Trixi.jl
@@ -63,6 +55,27 @@ julia> trixi_include("examples/euler/dry_air/buoyancy/elixir_gemein_bubble.jl")
6355
```
6456
Please see our documentation for more advanced setups.
6557

58+
## Referencing
59+
You can directly refer to TrixiAtmo.jl as
60+
61+
```bibtex
62+
@software{trixiatmo_18297711,
63+
author = {Artiano, Marco and
64+
Gassner, Gregor and
65+
Geihe, Benedict and
66+
Montoya, Tristan and
67+
Ranocha, Hendrik and
68+
Rueda-Ramírez, Andrés and
69+
Schlottke-Lakemper, Michael},
70+
title = {TrixiAtmo.jl}: athmospheric flow simulations with {Trixi.jl},
71+
month = jan,
72+
year = 2026,
73+
publisher = {Zenodo},
74+
version = {0.1.0},
75+
doi = {10.5281/zenodo.18297711},
76+
url = {https://doi.org/10.5281/zenodo.18297711},
77+
}
78+
```
6679

6780
## Authors
6881
TrixiAtmo.jl is maintained by the
@@ -73,6 +86,7 @@ It was initiated by
7386
[Benedict Geihe](https://www.mi.uni-koeln.de/NumSim/), and
7487
[Tristan Montoya](https://tjbmontoya.com/)
7588
(University of Cologne, Germany).
89+
The full list of contributors can be found in [AUTHORS.md](AUTHORS.md).
7690

7791
## License and contributing
7892
TrixiAtmo.jl is licensed under the MIT license (see [LICENSE.md](LICENSE.md)).

0 commit comments

Comments
 (0)