https://github.com/fl03/smplx

smplx is a toolkit for working with simplicial objects.
https://github.com/fl03/smplx

crates-io mathematics rust-lang simplex topology

Last synced: 2 months ago
JSON representation

smplx is a toolkit for working with simplicial objects.

• Host: GitHub
• URL: https://github.com/fl03/smplx
• Owner: FL03
• License: apache-2.0
• Created: 2024-07-24T14:45:41.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-09-09T12:44:56.000Z (4 months ago)
• Last Synced: 2024-09-10T03:33:08.229Z (4 months ago)
• Topics: crates-io, mathematics, rust-lang, simplex, topology
• Language: Rust
• Homepage: https://crates.io/crates/smplx
• Size: 37.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# smplx

[![crates.io](https://img.shields.io/crates/v/concision.svg)](https://crates.io/crates/smplx)

[![docs.rs](https://docs.rs/concision/badge.svg)](https://docs.rs/smplx)

[![license](https://img.shields.io/crates/l/smplx.svg)](https://crates.io/crates/smplx)

[![clippy](https://github.com/FL03/smplx/actions/workflows/clippy.yml/badge.svg)](https://github.com/FL03/smplx/actions/workflows/clippy.yml)

[![rust](https://github.com/FL03/smplx/actions/workflows/rust.yml/badge.svg)](https://github.com/FL03/smplx/actions/workflows/rust.yml)

***

_**The library is currently in the early stages of development and is not yet ready for production use.**_

Welcome to smplx, a topologically oriented crate focused on simplexes and their complexes.

## Features

- [ ] Simplex

- [ ] Complex

- [ ] Set

## Getting Started

### Building from the source

Start by cloning the repository

```bash

git clone https://github.com/FL03/smplx.git

cd smplx

```

```bash

cargo build --features full -r --workspace

```

## Usage

### Examples

#### _Simplex_

```rust

    extern crate smplx;

    fn main() -> Result<(), Box> {

        tracing_subscriber::fmt::init();

        tracing::info!("Welcome to smplx!");

        Ok(())

    }

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first

to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

* [Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)

* [MIT](https://choosealicense.com/licenses/mit/)