micromantid

Slimmed down Mantid framework targeted at WebAssembly

https://github.com/mducle/micromantid

Science Score: 54.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
  • Academic publication links
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Slimmed down Mantid framework targeted at WebAssembly

Basic Info
  • Host: GitHub
  • Owner: mducle
  • License: gpl-3.0
  • Language: CMake
  • Default Branch: main
  • Size: 1.25 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created about 1 year ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

microMantid

microMantid is a fork of Mantid 6.12 containing only a subset of the core Framework without the Workbench or GUI interfaces targetted at the WebAssembly platform so that it can run client-side-only within a web-browser.

Mantid

The Mantid project provides a framework that supports high-performance computing and visualisation of scientific data. Mantid has been created to manipulate and analyse Neutron and Muon scattering data, but could be applied to many other techniques. The framework is open source and is supported on multiple target platforms (Windows, Linux, macOS).

Building and testing

Note that only Linux builds are currently used and tested. Emscripten does support Windows and MacOS if you want to try it yourself on those platform.

You need to install conda or mamba, and then you can run the script to install and set up the environment and then use pyodide to build the project:

source ./setup_emsdk_env.sh pyodide build

The wheel will be put in the dist folder and can be uploaded to the website. To test the wheel you need to install node.js, then you can run:

npm install npm test

If you want to build for the native architecture rather the for WebAssembly, you can run:

mamba create -n native python=3.12 pybind11 libboost-python-devel libboost-devel gxx poco jsoncpp zlib hdf5 pytest eigen muparser gsl mamba activate native mkdir build cd build cmake .. cmake --build .

This will build the module file in the build folder. You can also use:

python -m pip wheel

to build a wheel instead. After installing the wheel you can run

python -m unittest

To run the tests.

Owner

  • Name: Duc Le
  • Login: mducle
  • Kind: user
  • Location: Harwell, UK
  • Company: Science and Technology Facilities Council

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use Mantid in your research, please cite it using this metadata."
abstract: "The Mantid project provides a framework that supports high-performance computing and visualisation of scientific data. Mantid has been created to manipulate and analyse Neutron and Muon scattering data, but could be applied to many other techniques. The framework is open source and is supported on multiple target platforms (Windows, Linux, macOS)."
authors:
  - name: "The Mantid Project team"
    email: mantid-help@mantidproject.org
    website: https://www.mantidproject.org/
title: Manipulation and Analysis Toolkit for Instrument Data
version: 6.11.0
doi: 10.5286/Software/Mantid6.11
date-released: 2024-10-24
keywords:
  - mantid
  - neutron
  - muon
  - particle physics
  - instrument
  - reduction
  - analysis
license:
  - GPL-3.0

GitHub Events

Total
  • Release event: 1
  • Delete event: 10
  • Push event: 34
  • Pull request event: 16
  • Create event: 13
Last Year
  • Release event: 1
  • Delete event: 10
  • Push event: 34
  • Pull request event: 16
  • Create event: 13

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 18
  • Total Committers: 1
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 18
  • Committers: 1
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Duc Le d****e@s****k 18
Committer Domains (Top 20 + Academic)

Dependencies

package.json npm
  • glob ^11.0.1
  • jest ^29.7.0
  • pyodide ^0.27.1
pyproject.toml pypi