Git Product home page Git Product logo

spectra's Introduction

Spectra

Spectra is a Python library that contains tools to process spectral data.

This repository contains research and implementation of spectral analysis. The first focus will be on preprocessing of LC/MS spectral data; the goal, however, is to include tools for all spectrometry and spectroscopy spectral analysis techniques.


Table of Contents

  1. Introduction
  2. Getting Started
  3. Development Setup
  4. Usage Examples
  5. Release History
  6. Contributing

Introduction

I'm interested in building a tool that automates algorithm selection for spectral analysis. Popular tools such as OpenMS and MZMine2 have put alot of work into building functional code to perform many tasks in, for example, Mass Spectrometry analysis. This effort hopes to stand apart from these works in two respects:

  1. We hope to enable, inform, and empower users by taking a algorithm-centric approach to analysis. As certain algorithms become commonplace, we place ourselves in danger by using algorithms that are widely adopted, which may not hone our algorithm intuition.
  2. We hope to automate inference on algorithm selection in order to scale process operations. Most algorithms are evaluated by visual inspection. Some use error models such as RMSE, but these strategies cannot discriminate artifacts from desired signals.

On an aside, I'm a big fan of Python, and can speak to increased productivity with Python development. As these modules mature, the Python implementations should be converted to jit using Python's numba package, and further optimized in C++. This work thus starts the exploration in Python.

Have a look at the documentation for more information on the algorithmic code, and take a look at the web application, spectra, to see performance of various algorithms.


Getting Started

Requirements

  1. Python 3.6.4+

Installation

  1. Clone the spectra repository.

    $ git clone --recursive https://www.github.com/francisglee/spectra
  2. Create and activate virtual environment.

    $ cd spectra
    $ python3.6 -m venv .venv
    $ source .venv/bin/activate
  3. Install requirements.

    (.venv)$ pip install -r requirements.txt
  4. Install environment onto Jupyter.

    (.venv)$ python3.6 -m ipykernel install --user --name=venv
  5. Run Juypter notebook.

    (venv)$ jupyter notebook

Development Setup

Running Tests


Usage Examples


Release History

We use SemVer for versioning. For the versions available, see the tags on this repository.

2.0.0 - 1.1.0 - 1.0.0 -


Contributing

Authors

Built With


TODO

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.