Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
rmartinsanta committed Jun 3, 2021
2 parents 3e912c5 + 0c94eeb commit 7037fa6
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ https://math.nist.gov/scimark2/credits.html

## Usage

### Independently
### Standalone

Download latest release or compile from source using Maven:

Expand Down Expand Up @@ -64,4 +64,20 @@ Process finished with exit code 0

### As a library

TODO
Available at maven central:
```xml
<dependency>
<groupId>es.urjc.etsii.grafo</groupId>
<artifactId>scimark</artifactId>
<version>2.1.0</version>
</dependency>
```

Example usage:
```java
var benchmarkResult = ScimarkAPI.runBenchmark(); // Optionally set a seed, large run, or custom config
double score = benchmarkResult.getScore();
```

The benchmark may fail under rare circunstances, throwing `BenchmarkException` and a message explaining why.

0 comments on commit 7037fa6

Please sign in to comment.