# vegas-rs

[![Crates.io](https://img.shields.io/crates/v/vegas.svg)](https://crates.io/crates/vegas)
[![Build Status](https://github.com/odarbelaeze/vegas-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/odarbelaeze/vegas-rs/actions/workflows/rust.yml)
[![Documentation](https://docs.rs/vegas/badge.svg)](https://docs.rs/vegas)
[![DOI](https://zenodo.org/badge/48195121.svg)](https://zenodo.org/badge/latestdoi/48195121)

## Introduction

This is an experimental implementation of an atomistic simulation package for
magnetic systems. **vegas-rs**'s main goal is to determine how performant is
the [rust](www.rust-lang.com) language for this kind of application.

## Installation

To install **vegas-rs** you need to have the rust installed. Then, you can
install **vegas-rs** by running the following command:

```bash
cargo install vegas
```

If you want to install **vegas-rs** as a library, you can add it via cargo:

```bash
cargo add vegas
```