Skip to content

Commit 0a02803

Browse files
committed
Update README.md
1 parent 1751593 commit 0a02803

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# FlightData
22
Flight data (log files) for model validation
3+
4+
## Use as a Julia Artifact
5+
6+
This repository can be used as a [Julia artifact](https://pkgdocs.julialang.org/v1/artifacts/) for downloading flight data in packages or scripts.
7+
8+
### In a project
9+
10+
Add the following to your `Artifacts.toml`:
11+
12+
```toml
13+
[flight_data]
14+
git-tree-sha1 = "9ac5fb6863ecdce392c784302e2d3169918a23f2"
15+
16+
[[flight_data.download]]
17+
sha256 = "7c93b77c8fe3a3a78fb8268699c51d200e305736cedce6c01b67d21ef6f7d66e"
18+
url = "https://github.com/OpenSourceAWE/FlightData/releases/download/v0.1.0/flight_data.tar.gz"
19+
```
20+
21+
Then access the data in Julia:
22+
23+
```julia
24+
using ArtifactUtils # or LazyArtifacts
25+
datadir = @artifact "flight_data"
26+
# datadir now points to the extracted flight_data/ folder
27+
```
28+
29+
### Manual download
30+
31+
The tarball can also be downloaded and extracted manually:
32+
33+
```bash
34+
curl -LO https://github.com/OpenSourceAWE/FlightData/releases/download/v0.1.0/flight_data.tar.gz
35+
tar -xzf flight_data.tar.gz
36+
```

0 commit comments

Comments
 (0)