Skip to content
This repository has been archived by the owner on Feb 9, 2022. It is now read-only.

Commit

Permalink
Updated changelog and readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
ggirelli committed Jun 17, 2019
1 parent 4936e23 commit 7da7a56
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## Unreleased
### ...
- ...

## [0.1.0] - 2019-06-17
### Changed
- Implemented as an ElectronJS-based app.

Expand All @@ -29,4 +33,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
[Unreleased] https://github.com/ggirelli/spectrascope/
[0.0.1] https://github.com/ggirelli/spectrascope/releases/tag/v0.0.1
[0.0.2] https://github.com/ggirelli/spectrascope/releases/tag/v0.0.2
[0.0.3] https://github.com/ggirelli/spectrascope/releases/tag/v0.0.3
[0.0.3] https://github.com/ggirelli/spectrascope/releases/tag/v0.0.3
[0.1.0] https://github.com/ggirelli/spectrascope/releases/tag/v0.1.0
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,39 @@ Interactive interface to visualize spectra and filter sets for any microscope. E

The idea behind **SpectraScope** is to provide users with an *easy-to-use* web-interface (that can be directly downloaded and run locally) where to visualize fluorophores and microscope filter sets of interest. This can be invaluable when setting up new optical configurations or designing new microscopy-based experiments.

**Notice!** This interface has been developed for GoogleChrome (v74) and FireFox (v66).
Thus, it may not be fully compatible with other browsers (e.g., Safari, IExplorer,...).
SpectraScope is available both as a webpage and as an ElectronJS-based app. You can choose your flavor and download it from the [releases](https://github.com/ggirelli/SpectraScope/releases) page.

**Notice!** The webpage interface has been developed for GoogleChrome (v74) and FireFox (v66). Thus, it may not be fully compatible with other browsers (e.g., Safari, IExplorer,...).

Live demo
---
A live demo of **SpectraScope**, click on the screenshot below to access it.
A live demo of **SpectraScope** webpage is hosted on github, click on the screenshot below to access it.
[![demo-screenshot](screenshot.png)](https://ggirelli.github.io/SpectraScope/app.html)

Features
---

#### For both webpage and webapp

* Visualize excitation/emission spectra of any fluorophore of interest in the 250-900 nm range. The fluorophore color is automatically selected based on the emission peak in the visible range by using the [wave2color](https://github.com/ggirelli/wave2color) functions.
* Visualize the transmission spectrum of any filter or dicroic mirror of interest, overlayed to the fluorophore spectra.
* Visualize the intensity spectrum of any light source of interest, overlayed to the fluorophore spectra.
* Explore the spectra with the mouse, seeing the precise relative intensity and wavelength of any point of interest.
* Quickly see a brief description of any spectrum by hovering over it with the mouse, and access the raw data by clicking on them.

Installation
---
#### For webapp only

Either download the repository's [zip file](https://github.com/ggirelli/SpectraScope/archive/master.zip) or clone it with `git` using:
* Manage your own settings template, including microscopes, light sources, optical elements, and fluorophores directly through the interface.

```bash
git clone http://github.com/ggirelli/spectrascope/web
```

Then, simply open the `app.html` file with your browser!
Installation
---

**Notice!** This interface has been developed for GoogleChrome (v74) and FireFox (v66). Thus, it may not be fully compatible with other browsers (e.g., Safari, IExplorer,...).
Download your flavor of choice (webpage or webapp) for your Operating System from the [releases](https://github.com/ggirelli/SpectraScope/releases) page.

### Known issues

#### webpage

Please, notice that **GoogleChrome** does not allow `crossorigin` requests from local files (i.e., when the address starts with something like `file://` or `C:/`). Thus, when opening `SpectraScope` locally, we recommend either using Mozilla FireFox or installing this tool on an Apache Server.

Usage
Expand Down

0 comments on commit 7da7a56

Please sign in to comment.