Data

Tools

Indexes

Applications

Experiments

Open Source Science

ermac

Ermac is a standalone MPDS platform GUI to be embedded in any website

https://github.com/mpds-io/ermac

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

materials-design materials-genome materials-informatics materials-platform materials-science mpds-api mpds-platform
Last synced: 6 months ago · JSON representation ·

Repository

Ermac is a standalone MPDS platform GUI to be embedded in any website

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 3
  • Open Issues: 8
  • Releases: 2
Topics
materials-design materials-genome materials-informatics materials-platform materials-science mpds-api mpds-platform
Created almost 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Ermac

DOI

MPDS free open-source GUI

Ermac is an embeddable GUI of the MPDS platform. It allows browsing the MPDS scientific data from any website or integrating the MPDS GUI into the existing codebases.

Ermac is completely free software. Upon compilation it's just a few static web assets. Copy these files to your web-server in a subfolder and enjoy your own MPDS platform. The data stays at the MPDS server.

Usage

An arbitrary static web-server is required, e.g. python -m http.server or php -S localhost:5555 or npm i -g http-server && http-server or whatever. All the content is static. In the development mode, the code is served from the src_js folder. In the production mode, the code in src_js should be compiled into a bundle ermac.min.js, which is then served. See example_dev.html and example_prod.html correspondingly.

``` git clone https://github.com/mpds-io/ermac cd ermac

then run your static web-server and open it in a web-browser

```

Technical details

Ermac is just a thin browser client (with a little fat). From whatever physical location, it talks to the MPDS platform servers at the api.mpds.io domain. Beware, Ermac employs the old-style JQuery-fashioned ES5 JavaScript (see src_js folder). The Node and npm are intentionally NOT used. Several external dependencies are supplied simply along with the codebase in third_party and src_js/third_party folders. For future, we consider re-implementation of this codebase in the modular TypeScript framework. Please contact us if you'd like to know more or help.

Compilation

Compilation into the production bundle ermac.min.js from src_js is done via the Google Closure Compiler supplied in third_party/jscomp folder, see deploy/build_js.sh script. For that you need a Java Runtime Environment (JRE), i.e. a command java -version should not produce an error in your terminal. On a typical Unix, such as Debian, JRE is installed e.g. like this:

apt-get -y update && apt-get -y upgrade apt-get install default-jre java -version

Given your JRE works, compilation is done as follows:

bash deploy/build_js.sh

The resulted file ermac.min.js is to be included into your webpage (see example_prod.html). Alternatively, see Ermac demo which is just a repository branch gh-pages compiled by GitHub action and served at the custom domain.

License

MIT © Evgeny Blokhin, Tilde Materials Informatics

Owner

  • Name: MPDS
  • Login: mpds-io
  • Kind: organization
  • Email: support@mpds.io
  • Location: The Internet

MPDS stands for Materials Platform for Data Science. It provides curated high-quality materials data, manually extracted from about 400k scientific publications

Citation (CITATION.cff) 

cff-version: 1.2.0
title: Ermac
type: software
license: MIT
authors:
  - given-names: Evgeny
    family-names: Blokhin
    orcid: 'https://orcid.org/0000-0002-5333-3947'
doi: 10.5281/zenodo.7693197
url: 'https://github.com/mpds-io/ermac'
keywords:
  - materials science
  - materials informatics
  - materials platform
  - materials design
  - MPDS
  - materials API
  - materials genome

GitHub Events

Total
  • Create event: 2
  • Issues event: 1
  • Release event: 1
  • Push event: 27
  • Pull request event: 1
Last Year
  • Create event: 2
  • Issues event: 1
  • Release event: 1
  • Push event: 27
  • Pull request event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 8
  • Total pull requests: 4
  • Average time to close issues: 11 months
  • Average time to close pull requests: 4 months
  • Total issue authors: 1
  • Total pull request authors: 3
  • Average comments per issue: 0.38
  • Average comments per pull request: 1.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • blokhin (8)
Pull Request Authors
  • VladlenaCravcenco (2)
  • stan-donarise (2)
  • Valexr (1)
Top Labels
Issue Labels
enhancement (6) bug (4) help wanted (1) documentation (1)
Pull Request Labels

Dependencies

.github/workflows/deploy-to-gh.yml actions
  • JamesIves/github-pages-deploy-action 4.1.7 composite
  • actions/checkout v3 composite
  • actions/setup-java v3 composite