Giter Club home page Giter Club logo

scibeam's Introduction

logo

SciBeam Build Status codecov PyPI version Documentation Status

scibeam is a python package build on top of pandas, numpy, sicpy and matplotlib. It is aimed for quick and easy scientific time-series data analysis and visualization in physics, optics, mechanics, and many other STEM subjects.

In the context of scientific data analysis, there are a lot of situations that people have to deal with time-series data, such as time dependent experiment(e.g. temperature measurement), dynamic processes(e.g. beam propagation, chemical reaction), system long/short term behavior(e.g. noise), etc. Quite often is that data taking and result analysis is gaped by some time and effort, which could result in complains or regrets during the data analysis, like “I wish I took another measurement of … so than I could explain why …”. As such, the general guidline of scibeam is to bridge the gap between measurement and data analysis, so that time-series related experiment can be done in a more guided way.

The basic features of scibeam include but not limited to: beam propagation, single or multi-dimentional time depedent measurement, data file auto indexing, noise reduction, peak analysis, numerical fittings, etc.

Installation

Dependencies

SciBeam requires:

  • Python( >= 3.4)
  • Numpy( >= 1.8.2)
  • Scipy( >= 0.13.3)
  • pandas ( >= 0.23.0)
  • matplotlib ( >= 1.5.1)
  • re
  • os

User installation

Currently only avaliable through downloading from Github, will be avaliable for installation through pip soon:

Using PyPI

pip install scibeam  

Using souce code

Download the souce code:

git clone https://github.com/SuperYuLu/SciBeam`  

Change to the package directory:

cd scibeam  

Install the package:

python setup.py install  

Documents

All documentation is avaliable here

Release

  • v0.1.0: 08/19/2018 first release !
  • v0.1.1: 08/22/2018 first release !

Development

Under active development.

TODO:

  • Increase test coverage
  • Add more plotting functions
  • Add config.py for global configurature
  • Add AppVeyor

Contribute

Call for contributors !

As a open source project, scibeam is under active development towards version 1.0, thus we need contributors from the conmunity.Please follow the steps if you want to contribute:

Testing

The testing part is based on unittest and can be run through setuptools, please refer to the documents

To run the test:

python setup.py test  

or

make test

Status

Version 0.1.1 on PyPI

scibeam's People

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

scibeam's Issues

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.