Giter Club home page Giter Club logo

frame's Introduction

FRAME

License: GPL v3

FRactionation And Mixing Evaluation of isotopes.

Markov-chain Monte Carlo engine for calculation of isotope mixinng wrapped in a simple Qt user interface.

See the webpage for a user guide, information of newest releases and more.

Install

Executables

  • Windows: see the zipped executables in releases (only Windows 10 compatible for now)
  • Linux and OSX: no exectuables were prepared yet. Let us know if you wish to use our software on these platforms or run the code from sources as described below.

Install from source

To get the sources from git do

$ git clone https://github.com/malewick/frame.git:

Install the packages listed in requirements.txt (either with conda or pip). Then run:

python FRAME.py

Alternatively you can run the code without the graphical interface with (see the source for details and input directory for some sample input files):

python run_batch.py

Docs and user guide

The user guide can be found under this link

A more detailed scientific description is published here: [link to the paper]

Discussion and bugs report

Our mailing list is at https://groups.google.com/g/frame-isotopes. You can ask questions about the underlying algorithms, usage, etc.

Our issue tracker is at https://github.com/malewick/frame/issues. Please report any bugs that you find.

Code

In the src directory:

  • FRAME.py is the main script producing the GUI.
  • NDimModel.py contains the implementation of the model and statstical calculations.
  • TimeSeriesPlot.py, PathPlot.py, CorrelationPlot.py are the classes with mpl plots implementation.

requirements.txt lists all the required packages and versions (PySide2, pandas, numpy, sympy, matplotlib).

Attribution

Please cite the following paper when using this code:

  • [to be supplemented]

It is expected that changes to the code are documented.

Copyright (C) 2020-2021 Maciej P. Lewicki

frame's People

Contributors

malewick avatar

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.