Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# v0.0.1

## added

## modified

## deleted

49 changes: 49 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing Guide

Thanks for the interest in contributing to this awesome project !, in order to get you up to speed in terms of sharing your contributed work, or intentions, consider the following:

1. `cargo clippy` with no warnings/errors.
2. `cargo tests` right after fork, and before your submission.

## Lints

This project, for the stable version, has implemented the following lints:

```toml
[workspace.lints.rust]
unsafe_code = "forbid"
unused_extern_crates = "forbid"
unreachable_code = "forbid"
unreachable_patterns = "forbid"
unused_variables = "warn"
trivial_casts = "warn"
trivial_numeric_casts = "warn"
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(nightly)'] }
```

## rustfmt.toml

Consider all defaults to be present, and, the following changed:

```toml
reorder_modules = true
max_width = 90
```

## Code format with rustfmt

For the `atelier-rs` crate, there is a `.rustfmt.toml` config file, even though must of the values are exactly the same as the default, they were included for future-proof purposes in terms of formatting.

## Reporting a Bug

In the case that you've found a bug, please make sure you are able to answer the following:

```
- What version of Rust are you using?
- What version of the crate are you using?
- What operating system are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
```

41 changes: 41 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[workspace]
resolver = "2"
members = [
"sm-data",
"sm-mass",
"benches",
"tests",
]

[workspace.package]
edition = "2024"
rust-version = "1.85"

description = "Subsequential Timeseries Clustering for anomaly detection in Timeseries Data"
authors = ["IteraLabs.ai"]
documentation = "https://docs.rs/supermass-rs/"
repository = "https://github.com/iteralabs/supermass-rs"
homepage = "https://iteralabs.xyz/supermass-rs"

keywords = ["framework", "math", "timeseries"]
categories = ["data-structures", "development-tools"]
include = ["katex-header.html"]
exclude = ["assets/*", ".github", "Makefile.toml", "*.log", "tags"]

license = "Apache-2.0"

[workspace.dependencies]
rustfft = { version = "6.4" }
serde = { version = "^1.0", features = ["derive"] }
rayon = { version = "1.10" }

[workspace.lints.rust]
unsafe_code = "forbid"
unused_extern_crates = "deny"
unreachable_code = "deny"
unreachable_patterns = "deny"
unused_variables = "warn"
trivial_casts = "warn"
trivial_numeric_casts = "warn"
dead_code = "allow"
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(nightly)'] }
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
include Cargo.toml
recursive-include rust *.rs
10 changes: 10 additions & 0 deletions Makefile.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[tasks.doc-katex]
env = { "RUSTDOCFLAGS" = "--html-in-header katex-header.html" }
command = "cargo"
args = ["doc", "--no-deps"]

[tasks.all]
dependencies = [
"docs",
"doc-katex",
]
15 changes: 15 additions & 0 deletions benches/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[package]
name = "benches"
publish = false
readme = "README.md"
version = "0.0.1"
rust-version = "1.85"
edition = "2024"
authors = ["iteralabs.xyz"]

[dependencies]

serde = { workspace = true }
serde_json = { workspace = true }
toml = { workspace = true }

1 change: 1 addition & 0 deletions benches/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Benches
15 changes: 15 additions & 0 deletions katex-header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.css" integrity="sha384-9eLZqc9ds8eNjO3TmqPeYcDj8n+Qfa4nuSiGYa6DjLNcv9BtN69ZIulL9+8CqC9Y" crossorigin="anonymous">
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/katex.min.js" integrity="sha384-K3vbOmF2BtaVai+Qk37uypf7VrgBubhQreNQe9aGsz9lB63dIFiQVlJbr92dw2Lx" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/contrib/auto-render.min.js" integrity="sha384-kmZOZB5ObwgQnS/DuDg6TScgOiWWBiVt0plIRkZCmE6rDZGrEOQeHM5PcHi+nyqe" crossorigin="anonymous"></script>
<script>
document.addEventListener("DOMContentLoaded", function() {
renderMathInElement(document.body, {
delimiters: [
{left: "$$", right: "$$", display: true},
{left: "\\(", right: "\\)", display: false},
{left: "$", right: "$", display: false},
{left: "\\[", right: "\\]", display: true}
]
});
});
</script>
2 changes: 2 additions & 0 deletions rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
reorder_modules = true
max_width = 90
15 changes: 15 additions & 0 deletions sm-data/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[package]
name = "sm-data"
publish = false
readme = "README.md"
version = "0.0.1"
rust-version = "1.85"
edition = "2024"
authors = ["iteralabs.xyz"]

[dependencies]

serde = { workspace = true }
serde_json = { workspace = true }
toml = { workspace = true }

2 changes: 2 additions & 0 deletions sm-data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# sm-data

Empty file added sm-data/src/lib.rs
Empty file.
Empty file added sm-mass/Cargo.toml
Empty file.
3 changes: 3 additions & 0 deletions sm-mass/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# sm-mass


Empty file added sm-mass/src/bin/inner.rs
Empty file.
Empty file added sm-mass/src/lib.rs
Empty file.
15 changes: 15 additions & 0 deletions tests/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[package]
name = "tests"
publish = false
readme = "README.md"
version = "0.0.1"
rust-version = "1.85"
edition = "2024"
authors = ["iteralabs.xyz"]

[dependencies]

serde = { workspace = true }
serde_json = { workspace = true }
toml = { workspace = true }

1 change: 1 addition & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tests