Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 3.16 KB

README.md

File metadata and controls

69 lines (38 loc) · 3.16 KB
Raw

Virtual-HeNDI-Spectrometer

The Raston Lab's Helium NanoDroplet Isolation - Scientific Instrument Simulator (HeNDI-SIS) was designed to emulate a student's classroom experience with a HeNDI spectrometer. The web application is intended to provide users with an overview of the anatomy of a HeNDI. When used, the application allows users to experiment with changing parameters such as the nozzle temperature to better understand the effect of these parameters on the spectra collected by the instrument. The user can simulate collecting spectra at a variety of nozzle temperatures ranging between 13.5 and 20 K.

Original work on this project was started by Isaac Miller

Installation

NOTE: The frontend and backend exist together. The backend does not need to be run separately.

  1. Clone the repository

  2. Move into the cloned repository's directory

    cd Virtual-HeNDI-Spectrometer

  3. Install all npm dependencies

    npm install

  4. Run the server locally

    npm start

Usage

The intended audience for this application is undergraduate chemistry students studying spectroscopy. The following screenshots are not exhaustive but acknowledge most of the main features:

  • Instrument and Parameter View

TODO

  • Spectrum View

TODO

Contributing

This project is intended to be a project for recruited undergraduate students, but pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

Licensed under TODO

Relevant third-party tools and resources we depend on:

  • big.js: JavaScript library for arbitrary-precision decimal arithmetic (Licensed MIT)

  • Dygraphs: JavaScript library for interactive data visualization (Licensed MIT)

  • FileSaver.js: Solution for saving client-generated data as a file (Licensed MIT)

  • GitHub Pages Deploy Action: GitHub Action used to automate deployment of web applications to GitHub Pages (Licensed MIT)

  • MUI: React user interface component library (Licensed MIT)

  • React: JavaScript library for building user interfaces (Licensed MIT)

  • SVGO: Node.js tool for optimizing SVG files (Licensed MIT)

  • SVGOMG: Web GUI for SVGO (Licensed MIT)

  • SVGR: Tool for transforming SVGs into React components (Licensed MIT)