# Rust-FlightWeather
[![Pipeline Status main](https://gitlab.com/flightsimtools/r-fst/r-fw/badges/main/pipeline.svg?ignore_skipped=true&style=flat-square&key_text=main)](https://gitlab.com/flightsimtools/r-fst/r-fw/-/pipelines)
[![Pipeline Status develop](https://gitlab.com/flightsimtools/r-fst/r-fw/badges/develop/pipeline.svg?ignore_skipped=true&style=flat-square&key_text=develop)](https://gitlab.com/flightsimtools/r-fst/r-fw/-/pipelines)
[![Code Coverage](https://gitlab.com/flightsimtools/r-fst/r-fw/badges/main/coverage.svg?style=flat-square&key_text=Code+Coverage&key_width=100)](https://gitlab.com/flightsimtools/r-fst/r-fw/-/commits/main?ref_type=heads)
[![Latest Release](https://gitlab.com/flightsimtools/r-fst/r-fw/-/badges/release.svg?style=flat-square&key_text=Latest+Release&key_width=100)](https://gitlab.com/flightsimtools/r-fst/r-fw/-/releases)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg?style=flat-square)](CODE_OF_CONDUCT.md)

## Table Of Contents
1. [Description](#description)
2. [Current Release Version](#current-release-version)
3. [License](#license)
4. [Contribution](#contribution)
5. [Team](#team)

## Description
_Rust-FlightWeather_ is a library that decodes a METAR or TAF.

It was forked from [metar-rs](https://github.com/lilopkins/metar-rs) written by [Lily Hopkins](https://www.hpkns.uk/).

## Current Release Version
v2.0.1

## Quick usage
This usage will print out the parsed data from a METAR:

```rust
use rust_flightweather::metar::Metar;

fn main() {
  let metar = "EGHI 282120Z 19015KT 140V220 6000 RA SCT006 BKN009 16/14 Q1006";
  let result = Metar::parse(metar).unwrap();
  println!("{:#?}", result);
}
```

This usage will print out the parsed data from a TAF:

```rust
use rust_flightweather::taf::Taf;

fn main() {
  let taf = "TAF LUDO 130530Z 1307/1316 31015KT 8000 SHRA FEW005 FEW010CB SCT018 BKN025 TEMPO 1311/1316 4000 +SHRA PROB30 TEMPO 1314/1316 TSRA SCT005 BKN010CB";
  let result = Taf::parse(taf).unwrap();
  println!("{:#?}", result);
}
```

## Issues
METARs and TAFs are complicated structures.
If you come across one of them that doesn't parse correctly,
open an [issue](https://gitlab.com/flightsimtools/r-fst/r-fw/-/issues/new) and include the METAR or TAF.
This will significantly aid in debugging the issue.

Read [Contribution](#contribution) for more information.

## License
Rust-FlightWeather is licensed under the MIT License.
You can find the license text under [LICENSE](LICENSE).

For more information about this license,
visit [https://choosealicense.com/licenses/mit/](https://choosealicense.com/licenses/mit/).

## Contribution
You can find the source code at [https://gitlab.com/flightsimtools/r-fst/r-fw](https://gitlab.com/flightsimtools/r-fst/r-fw).

Read [CONTRIBUTING](CONTRIBUTING.md) when you wish to contribute to this project.

Note that this project is subject to a Contributor [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
By participating in this project, you agree to abide by its terms.

## Team
* Lucas Greuloch (@greluc)

[<img src="Logo_Rust.svg" height="150"/>](https://www.rust-lang.org/)