Skip to content

Commit cdaf6ba

Browse files
committed
create io: standard licensing
1 parent 82a6bb5 commit cdaf6ba

File tree

4 files changed

+37
-8
lines changed

4 files changed

+37
-8
lines changed

Cargo.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
22
name = "allan-tools"
3-
version = "0.1.2"
4-
license-file = "LICENSE"
3+
version = "0.1.3"
4+
license = "MIT OR Apache-2.0"
55
authors = ["Guillaume W. Bres <guillaume.bressaix@gmail.com>"]
66
categories = ["science","mathematics"]
77
homepage = "https://github.com/gwbres/allan-tools"
8-
keywords = ["allan", "deviation", "stability", "time", "frequency"]
8+
keywords = ["allan", "statistics", "stability", "time", "frequency"]
99
description = "Package to compute statistics to study systems stability"
1010
edition = "2018"
1111
readme = "README.md"
File renamed without changes.

LICENSE-MIT

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2015-2016 Kevin B. Knapp
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# allan-tools
22

3+
[![crates.io](https://img.shields.io/crates/v/allan-tools.svg)](https://crates.io/crates/allan-tools)
4+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/gwbres/allan-tools/blob/main/LICENSE-APACHE)
5+
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/gwbres/allan-tools/blob/main/LICENSE-MIT)
6+
[![crates.io](https://img.shields.io/crates/d/allan-tools.svg)](https://crates.io/crates/allan-tools)
37
[![Rust](https://github.com/gwbres/allan-tools/actions/workflows/rust.yml/badge.svg)](https://github.com/gwbres/allan-tools/actions/workflows/rust.yml)
48
[![crates.io](https://docs.rs/allan-tools/badge.svg)](https://docs.rs/allan-tools/badge.svg)
59

6-
[![crates.io](https://img.shields.io/crates/v/allan-tools.svg)](https://crates.io/crates/allan-tools)
7-
[![crates.io](https://img.shields.io/crates/d/allan-tools.svg)](https://crates.io/crates/allan-tools)
8-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
9-
1010
Allantools (python lib) portage to Rust
1111

1212
This library allows easy computations of Allan deviation & similar statistics.
1313
These statistical methods are mostly used in system stability studies.
1414

15-
### Variances / Deviations
15+
## Allan and other deviations
1616

1717
Compute Allan deviation over raw data:
1818

@@ -27,6 +27,14 @@ Compute Allan deviation over raw data:
2727

2828
This lib against `Time Lab`.
2929

30+
### Known calculations
31+
32+
* Deviation::Allan `adev`
33+
* Deviation::Modified `mdev`
34+
* Deviation::Time `tdev` (not fully tested yet)
35+
* Deviation::Hadamard `hdev` (not fully tested yet)
36+
* Deviation::Gcov `gcov` allan covariances (not tested yet)
37+
3038
### Error bars
3139

3240
Only basic (biased) error bars following the 1/√N decay are currently produced

0 commit comments

Comments
 (0)