https://github.com/fl03/slant

slant is a mathematical toolkit focused on providing interactive visualizations for abstract concepts
https://github.com/fl03/slant

animation crates-io mathematics rust visualization

Last synced: 9 days ago
JSON representation

slant is a mathematical toolkit focused on providing interactive visualizations for abstract concepts

• Host: GitHub
• URL: https://github.com/fl03/slant
• Owner: FL03
• License: apache-2.0
• Created: 2024-08-23T19:54:04.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-08-23T20:26:45.000Z (2 months ago)
• Last Synced: 2024-09-24T22:26:41.400Z (about 1 month ago)
• Topics: animation, crates-io, mathematics, rust, visualization
• Language: Rust
• Homepage: https://crates.io/crates/slant
• Size: 18.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# slant

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

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

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

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

[![license](https://img.shields.io/crates/l/slant.svg)](https://choosealicense.com/licenses/apache-2.0/)

***

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

Welcome to `slant`! Slant aims to be a complete mathematical toolbox providing an interactive sandbox for visualizing abstract mathematical concepts. The library is inspired by 3blue1brown's [manim](https://github.com/3b1b/manim) animation engine.

## Features

- [ ] `slant-anim` - Animation library

- [ ] `slant-plot` - Plotting library

## Getting Started

### Building from the source

Start by cloning the repository

```bash

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

cd slant

```

#### _Build the project_

```bash

cargo build --all-features --workspace

```

#### _Run the tests_

```bash

cargo test -F full --workspace

```

## Examples

### Basic Usage

```rust

    extern crate slant;

    fn main() -> anyhow::Result<()> {

        tracing_subscriber::fmt::init();

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

        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/)