Skip to content

Commit

Permalink
create io: standard licensing
Browse files Browse the repository at this point in the history
  • Loading branch information
gwbres committed Mar 13, 2022
1 parent 82a6bb5 commit cdaf6ba
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 8 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "allan-tools"
version = "0.1.2"
license-file = "LICENSE"
version = "0.1.3"
license = "MIT OR Apache-2.0"
authors = ["Guillaume W. Bres <[email protected]>"]
categories = ["science","mathematics"]
homepage = "https://github.com/gwbres/allan-tools"
keywords = ["allan", "deviation", "stability", "time", "frequency"]
keywords = ["allan", "statistics", "stability", "time", "frequency"]
description = "Package to compute statistics to study systems stability"
edition = "2018"
readme = "README.md"
Expand Down
File renamed without changes.
21 changes: 21 additions & 0 deletions LICENSE-MIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015-2016 Kevin B. Knapp

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# allan-tools

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

[![crates.io](https://img.shields.io/crates/v/allan-tools.svg)](https://crates.io/crates/allan-tools)
[![crates.io](https://img.shields.io/crates/d/allan-tools.svg)](https://crates.io/crates/allan-tools)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Allantools (python lib) portage to Rust

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

### Variances / Deviations
## Allan and other deviations

Compute Allan deviation over raw data:

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

This lib against `Time Lab`.

### Known calculations

* Deviation::Allan `adev`
* Deviation::Modified `mdev`
* Deviation::Time `tdev` (not fully tested yet)
* Deviation::Hadamard `hdev` (not fully tested yet)
* Deviation::Gcov `gcov` allan covariances (not tested yet)

### Error bars

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

0 comments on commit cdaf6ba

Please sign in to comment.