oat_rust 0.1.0

User-friendly tools for applied topology
Documentation

Open Applied Topology

Open applied topology (OAT) is a library for fast, user-friendly algebra and topology.

Documentation

There are two ways to view the documenation for this package.

Web browser

Select Documenation from the menu on the righthand side of the page at Crates.io

Build from source

First install Rust. If you already have Rust, make sure you have the most recent version. Next, obtain a copy of the the oat_rust git repository. Open a shell, CD into the repository, and run cargo doc --no-deps --open. The documentaiton homepage will then open in a browser. Documentation includes

Installation

Installation of this package is managed by the Rust feature Cargo.

  • See the Cargo documentation for details on compiling and running the code.
  • See the introduction_to_rust crate for a gentle introduction to programming in Rust.

Contributing

For information on contributing, see CONTRIBUTING.md.

License and attributions

For inforamtion on copyright and licensing, see LICENSE.

OAT is an extension of the ExHACT project, with major contributions from Pacific Northwest National Laboratory. For details see ATTRIBUTIONS.md.