Skip to content

parametrizes the default zoom stage of the plot #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alpae wants to merge 13 commits into
base: dev
Choose a base branch
from
Open

parametrizes the default zoom stage of the plot #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f592275
Merge pull request #10 from inab/dev
javi-gv94 May 19, 2020
8590404
added project license
javi-gv94 May 29, 2020
cda780e
Update README.md
dominikbruechner Nov 18, 2021
da8c775
published component to NPM
dominikbruechner Nov 18, 2021
dc8e2e2
Merge branch 'master' of https://github.com/inab/OpenEBench_scientifi…
dominikbruechner Nov 18, 2021
ccc8c88
update to new OEB API
dominikbruechner Nov 24, 2021
4eb794c
Merge branch 'dev'
dominikbruechner Nov 24, 2021
16c8e95
bumped npm version, merged develop branch to master, small api access…
dominikbruechner Nov 24, 2021
00ed2f0
Update README.md
dominikbruechner Dec 3, 2021
1f0ace5
Update README.md
dominikbruechner Dec 3, 2021
4c416e5
update package version
dominikbruechner Dec 3, 2021
07c399c
Update index.html
dominikbruechner Dec 10, 2021
3939d3c
parametrizes the default zoom stage of the plot
alpae Mar 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
675 changes: 675 additions & 0 deletions LICENSE
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 42 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# OpenEBench Scientific Benchmarking visualizer
Repository that contains the code required to visualize results from scientific benchmarking experiments in plot format, and apply several classification methods in order to transform them to tabular format.

## NPM Package
NPM Package `@inb/oeb-chart-scatter` published to: https://www.npmjs.com/package/@inb/oeb-chart-scatter

## Data Input
The visualizer uses as input the results of one challenge stored in the OpenEBench database in the format of the official [Benchmarking Data Model](https://github.com/inab/benchmarking-data-model).

Per default it consumes the [OpenEBench Sci-API](https://openebench.bsc.es/sciapi/) (deprecated).

It is also able to consume the new API [OpenEBench API Scientific](https://dev-openebench.bsc.es/api/scientific/).
The API can be set by supplying the following attribute: `data-api-url="{{ API_URL }}"`

## Branches
* master: Python visualizer scripts
* js: JavaScript visualizer project
Expand All @@ -12,8 +23,39 @@ Repository that contains the code required to visualize results from scientific
![diagonals](pictures/diag_example.png)
* Clustering - group the participants using the K-means clustering algorithm and sort the clusters according to the performance.
![clusters](pictures/clusters_example.png)


## How to use

The component can be imported in two way: As npm package (preferred), or via the build file from the git repository (see bottom).

### Use the npm package

`npm i @inb/oeb-chart-scatter`

In your frontend component:
`import { load_scatter_visualization } from "@inb/oeb-chart-scatter";`

```
<div
data-id="{{ ID }}"
class="benchmarkingChart_scatter"
data-api-url="{{ API_URL }}"
toTable="true"
></div>
```

You can then call the `load_scatter_visualization()` function.

### Attributes that can be set on the _<div\>_ tag

- data-id : the official OEB id of the aggregation dataset you want to visualize.
- toTable: should be set to true/false depending whether you want to view the classification table in the right or not.
- class: should always be *'benchmarkingChart_scatter'*
- data-api-url: Should always contain the full API URL e.g. https://openebench.bsc.es/api/scientific/graphql

### Alternative way: Clone from repository

Requirements:

-npm
Expand Down Expand Up @@ -41,12 +83,6 @@ Add JS cdn for D3 and jquery and the build file which you can download from buil

The HTML file should look like [this](./index.html)

### Attributes that can be set on the _<div\>_ tag

- data-id : the official OEB id of the aggregation dataset you want to visualize.
- toTable: should be set to true/false depending whether you want to view the classification table in the right or not.
- class: should always be *'benchmarkingChart_scatter'*


## Live Demo
See a demo of how this visualizer works [here](https://inab.github.io/OpenEBench_scientific_visualizer/)
Expand Down
60 changes: 30 additions & 30 deletions build/build.js
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
</head>

<body>
<div data-id="OEBD00200001HD" toTable="true" class="benchmarkingChart_scatter" data-mode="dev"></div>
<div data-id="invalid-id-here" toTable="true" class="benchmarkingChart_scatter" data-mode="dev"></div>
<div data-id="OEBD00200001HD" toTable="true" class="benchmarkingChart_scatter" data-api-url="https://dev-openebench.bsc.es/api/scientific/graphql"></div>
<div data-id="invalid-id-here" toTable="true" class="benchmarkingChart_scatter" data-api-url="https://dev-openebench.bsc.es/api/scientific/graphql"></div>
</body>


Expand Down
Loading