Init repository added readme and license file

Author: Ian

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish to crates.io
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - uses: katyo/publish-crates@v2
+        with:
+          registry-token: ${{ secrets.CARGO_REGISTRY_TOKEN }}

Cargo.lock

@@ -2,11 +2,17 @@
 name = "single-clustering"
 version = "0.1.0"
 edition = "2024"
+authors = ["Ian F. Diks"]
+homepage = "https://singlerust.com"
+repository = "https://github.com/SingleRust/single-clustering"
+license-file = "LICENSE.md"
+readme = "README.md"
+description = "A high-performance network clustering library implementing community detection algorithms like Louvain and Leiden. Features efficient graph representation, abstract grouping systems, and K-NN graph creation from high-dimensional data. Provides parallel computation support via Rayon for handling large networks."
+
 
 [dependencies]
 anyhow = "1.0.98"
 kiddo = "5.0.3"
-nalgebra = "0.33.2"
 nalgebra-sparse = "0.10.0"
 ndarray = {version = "0.16.1" , features = ["rayon"]}
 num-traits = "0.2.19"

Cargo.toml

@@ -0,0 +1,13 @@
+BSD 3-Clause License
+
+Copyright (c) 2025 Ian F. Diks All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

LICENSE.md

@@ -0,0 +1,56 @@
+# single-clustering
+
+A Rust library for community detection and graph clustering algorithms.
+
+## Features
+
+- **Network Analysis**: Efficient graph representation and manipulation for clustering tasks
+- **Community Detection**: Implementation of state-of-the-art algorithms
+    - Louvain method for community detection
+    - Leiden algorithm (enhanced version of Louvain)
+- **Flexible Grouping**: Abstract trait system for creating and managing node clusters
+- **Performance**: Parallel computation support via Rayon
+- **K-NN Graph Creation**: Build networks from high-dimensional data points
+
+## Usage
+
+```rust
+use single_clustering::network::Network;
+use single_clustering::network::grouping::VectorGrouping;
+use single_clustering::community_search::leiden::Leiden;
+
+// Create a network from your data
+let network = Network::new_from_graph(graph);
+
+// Initialize clustering (each node in its own cluster)
+let mut clustering = VectorGrouping::create_isolated(network.nodes());
+
+// Run Leiden algorithm (resolution parameter, randomness parameter, optional seed)
+let mut leiden = Leiden::new(1.0, 0.01, Some(42));
+leiden.iterate(&network, &mut clustering);
+
+// Access clustering results
+for node in 0..network.nodes() {
+    println!("Node {} belongs to cluster {}", node, clustering.get_group(node));
+}
+```
+
+## Installation
+
+Add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+single-clustering = "0.1.0"
+```
+
+## Performance Considerations
+
+The library offers multiple implementations optimized for different scenarios:
+- `StandardLocalMoving`: Basic implementation of the moving algorithm
+- `FastLocalMoving`: Optimized version with better memory usage
+- Parallel implementations of various operations for large networks
+
+## License
+
+This crate is licensed under the MIT License.