Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.99 KB

readme.md

File metadata and controls

53 lines (35 loc) · 1.99 KB
Raw

Sedenion Engine

npm GitHub codecov

Sedenion Engine is an open-source project that offers a scientific calculator and CAS (Computer Algebra System) solver. This repository contains the Rust source code used by Sedenion to parse and evaluate expressions.

Building the Project

To build the Sedenion engine to WebAssembly (wasm), follow these steps:

  1. Make sure you have wasm-pack installed on your system.
  2. Execute the following command: wasm-pack build --target bundler.
  3. The NPM package will be generated and stored in the pkg directory.

License

This project is licensed under GNU GPL-v3. You can find more detailed information in the LICENSE file located in the root of this repository.

Features

Currently Sedenion engine only supports numerical evaluation.

Getting Started

To use the Sedenion Engine in your project, follow the steps below:

  1. Install the NPM package generated during the build process.

    npm install sedenion_engine

  2. Import the Sedenion module in your JavaScript or TypeScript code.

    import {} from 'sedenion-engine';

  3. Call the functions in your app.

    const result = evaluate('2 + 2');
console.log(result); // Output: 4

Contributing

We welcome contributions from the community to enhance Sedenion Engine further. If you want to contribute, please follow the guidelines outlined in the contributing.md file.

Support

If you encounter any issues or have questions regarding the Sedenion Engine, please open an issue on our GitHub repository.

Acknowledgments

We would like to express our gratitude to all the developers and contributors who have made this project possible.