Merge branch 'main' of https://github.com/instaclustr/atsc into issue-101-docs

Author: cjrolo

CONTRIBUTING.md

@@ -21,7 +21,7 @@ This project adheres to a code of conduct that is based on respect, collaboratio
 
 ### Reporting Issues
 
-If you encounter a bug, performance issue, or have a suggestion for an enhancement, please open an issue in our [GitHub repository](https://github.com/instaclustr/fft-compression/issues). Make sure to provide as much detail as possible to help us understand the problem or suggestion. **But check for existing issues first!**
+If you encounter a bug, performance issue, or have a suggestion for an enhancement, please open an issue in our [GitHub repository](https://github.com/instaclustr/atsc/issues). Make sure to provide as much detail as possible to help us understand the problem or suggestion. **But check for existing issues first!**
 
 When reporting an issue, please include:
 - A clear and descriptive title.
@@ -45,7 +45,7 @@ We accept contributions via Pull Requests (PRs). Before submitting a PR, please
 
 #### How to Create a Pull Request (PR)
 
-1. Go to the [GitHub repository](https://github.com/instaclustr/fft-compression).
+1. Go to the [GitHub repository](https://github.com/instaclustr/atsc).
 2. Click on the "Pull Requests" tab.
 3. Press the **"New pull request"** button.
 4. Select the **base repository** and the branch where you want to merge your changes (`main`).
@@ -100,6 +100,6 @@ Feel free to contribute to these ongoing efforts or propose your own enhancement
 
 We value your feedback and suggestions! If you have any ideas on how to improve the BRRO Compressor, please don't hesitate to share them. You can do so by:
 
-- Opening a new issue labeled as a `suggestion` in our [GitHub repository](https://github.com/instaclustr/fft-compression).
+- Opening a new issue labeled as a `suggestion` in our [GitHub repository](https://github.com/instaclustr/atsc).
 
 Your input helps us shape the future of the project, and we appreciate any suggestions or feedback you can provide.

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 members = [
-    "brro-compressor",
+    "atsc",
     "tools",
     "wavbrro",
     "vsri",

Cargo.toml

@@ -1,4 +1,4 @@
-# FFT-compression Maintainers
+# ATSC Maintainers
 
 ## Maintainers
 

MAINTAINERS.md

@@ -1,5 +1,5 @@
 [package]
-name = "brro-compressor"
+name = "atsc"
 version = "0.5.0"
 authors = ["Carlos Rolo <[email protected]>"]
 edition = "2021"

brro-compressor/Cargo.toml atsc/Cargo.toml

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-use brro_compressor::compressor::fft::{fft, fft_allowed_error, fft_set, fft_to_data, FFT};
+use atsc::compressor::fft::{fft, fft_allowed_error, fft_set, fft_to_data, FFT};
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 use std::path::PathBuf;
 use wavbrro::wavbrro::WavBrro;

brro-compressor/benches/fft_bench.rs atsc/benches/fft_bench.rs

@@ -15,9 +15,7 @@ limitations under the License.
 */
 
 // Import necessary libraries
-use brro_compressor::compressor::polynomial::{
-    polynomial, polynomial_allowed_error, to_data, PolynomialType,
-};
+use atsc::compressor::polynomial::{polynomial, polynomial_allowed_error, to_data, PolynomialType};
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
 
 // Define example sample data

brro-compressor/benches/polynomial_bench.rs atsc/benches/polynomial_bench.rs

@@ -11,37 +11,37 @@ do
 
     cp $infilename tmp.wbro 
 
-    ../../target/debug/brro-compressor --compressor fft --error $i --verbose tmp.wbro > $mfile
+    ../../target/debug/atsc --compressor fft --error $i --verbose tmp.wbro > $mfile
     echo "FFT Size: "
     du -sb tmp.bro
-    ../../target/debug/brro-compressor -u --verbose tmp.bro >> $mfile
+    ../../target/debug/atsc -u --verbose tmp.bro >> $mfile
 
     sed -i -e 's/Output/output_fft/g'  $mfile
 
     cp $infilename tmp.wbro 
 
-    ../../target/debug/brro-compressor --compressor idw --error $i tmp.wbro > /dev/null
+    ../../target/debug/atsc --compressor idw --error $i tmp.wbro > /dev/null
     echo "IDW Size: "
     du -sb tmp.bro
-    ../../target/debug/brro-compressor -u --verbose tmp.bro >> $mfile
+    ../../target/debug/atsc -u --verbose tmp.bro >> $mfile
 
     sed -i -e 's/Output/output_idw/g'  $mfile
 
     cp $infilename tmp.wbro 
 
-    ../../target/debug/brro-compressor --compressor polynomial --error $i tmp.wbro > /dev/null
+    ../../target/debug/atsc --compressor polynomial --error $i tmp.wbro > /dev/null
     echo "Polynomial Size: "
     du -sb tmp.bro
-    ../../target/debug/brro-compressor -u --verbose tmp.bro >> $mfile
+    ../../target/debug/atsc -u --verbose tmp.bro >> $mfile
 
     sed -i -e 's/Output/output_poly/g'  $mfile
 
     cp $infilename tmp.wbro 
 
-    ../../target/debug/brro-compressor --error $i tmp.wbro > /dev/null
+    ../../target/debug/atsc --error $i tmp.wbro > /dev/null
     echo "Auto Size: "
     du -sb tmp.bro
-    ../../target/debug/brro-compressor -u --verbose tmp.bro >> $mfile
+    ../../target/debug/atsc -u --verbose tmp.bro >> $mfile
 
     sed -i -e 's/Output/output_auto/g'  $mfile
 

brro-compressor/demo/run_demo.sh atsc/demo/run_demo.sh

@@ -14,10 +14,10 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-use brro_compressor::compressor::Compressor;
-use brro_compressor::data::CompressedStream;
-use brro_compressor::optimizer::OptimizerPlan;
-use brro_compressor::utils::readers::bro_reader;
+use atsc::compressor::Compressor;
+use atsc::data::CompressedStream;
+use atsc::optimizer::OptimizerPlan;
+use atsc::utils::readers::bro_reader;
 use clap::{arg, command, Parser};
 use log::{debug, error};
 use std::error::Error;

brro-compressor/src/compressor/constant.rs atsc/src/compressor/constant.rs

@@ -1,4 +1,4 @@
-use brro_compressor::utils::error::calculate_error;
+use atsc::utils::error::calculate_error;
 use std::fs;
 use std::path::{Path, PathBuf};
 use wavbrro::wavbrro::WavBrro;
@@ -117,7 +117,7 @@ fn prepare_test_dir() -> PathBuf {
 
 /// Runs compressor binary with provided arguments.
 fn run_compressor(args: &[&str]) {
-    let compressor_bin = env!("CARGO_BIN_EXE_brro-compressor");
+    let compressor_bin = env!("CARGO_BIN_EXE_atsc");
     let exit_status = std::process::Command::new(compressor_bin)
         .args(args)
         .status()

brro-compressor/src/compressor/fft.rs atsc/src/compressor/fft.rs

@@ -102,7 +102,7 @@ fn compress_file_with_speed(speed: u8) {
 
 fn run_compressor(args: &[&str]) {
     // path to binary set by cargo: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates
-    let command = std::env!("CARGO_BIN_EXE_brro-compressor");
+    let command = std::env!("CARGO_BIN_EXE_atsc");
 
     let status = std::process::Command::new(command)
         .args(args)

brro-compressor/src/compressor/mod.rs atsc/src/compressor/mod.rs

@@ -2,12 +2,12 @@
 name = "csv-compressor"
 version = "0.1.0"
 edition = "2021"
-description = "Utilizes brro-compressor functionalities to compress CSV formatted data"
+description = "Utilizes ATSC functionalities to compress CSV formatted data"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-brro-compressor = { version = "0.5.0", path = "../brro-compressor" }
+atsc = { version = "0.5.0", path = "../atsc" }
 clap = { workspace = true, features = ["derive"] }
 csv = "1.3.0"
 serde = { version = "1.0.171", features = ["derive"] }

brro-compressor/src/compressor/noop.rs atsc/src/compressor/noop.rs

@@ -15,10 +15,10 @@ limitations under the License.
 */
 
 use crate::metric::Metric;
-use brro_compressor::compressor::Compressor;
-use brro_compressor::data::CompressedStream;
-use brro_compressor::optimizer::OptimizerPlan;
-use brro_compressor::utils::readers::bro_reader::read_file;
+use atsc::compressor::Compressor;
+use atsc::data::CompressedStream;
+use atsc::optimizer::OptimizerPlan;
+use atsc::utils::readers::bro_reader::read_file;
 use clap::{arg, Parser};
 use log::debug;
 use std::fs;