An open API service indexing awesome lists of open source software.

https://github.com/santisoler/simpeg-benchmarks-magnetic

Benchmarks between magnetic forward models in SimPEG
https://github.com/santisoler/simpeg-benchmarks-magnetic

Last synced: 6 months ago
JSON representation

Benchmarks between magnetic forward models in SimPEG

Awesome Lists containing this project

README

          

# Benchmarks for comparing magnetic simulations in SimPEG

## Get started

In order to run these benchmarks, you need to have a Python distribution like
[Miniforge][miniforge] installed.

Then, clone this repository:

```bash
git clone https://github.com/santisoler/simpeg-benchmarks-magnetic
cd simpeg-benchmarks-magnetic
```

And create a `conda` environment with all the required dependencies for running
these benchmarks:

```bash
conda env create -f environment.yml
```

## Run the benchmarks

All benchmarks can be run by executing the Python scripts in `code`
folder.

Alternatively, we can run all benchmarks by executing the `run.sh` shell
script:

```bash
bash run.sh
```

> **Important**
> Most of the benchmarks were designed to be run on a machine with 125GB of ram and
> a minimum of 30 threads. If your system don't meet these specs, you can
> modify the scripts to adjust them to your needs.

[miniforge]: https://github.com/conda-forge/miniforge