Metadata-Version: 2.1
Name: bfit
Version: 4.5.1
Summary: BNMR/BNQR Data Fitting and Visualization
Home-page: https://github.com/dfujim/bfit
Author: Derek Fujimoto
Author-email: fujimoto@phas.ubc.ca
License: UNKNOWN
Description: # bfit
        Beta-NMR GUI for reading, drawing, fitting data. 
        
        ## Run Instructions
        
        To run the gui, call `python3 -m bfit`
        
        bfit also provides the following classes and functions at the top level:
        
        * Functions
            * `bfit.pulsed_exp`
            * `bfit.pulsed_strexp`
            * `bfit.pulsed_biexp`
            * `bfit.lorentzian` 
            * `bfit.bilorentzian`
            * `bfit.quadlorentzian`
            * `bfit.gaussian`
            
        * Minimization
            * `bfit.minuit`
            * `bfit.global_fitter`
            * `bfit.global_bdata_fitter`
            * `bfit.fit_bdata`
        
        A description of these functions can be found [here](https://github.com/dfujim/bfit/blob/master/bfit/fitting/README.md). 
        
        
        ## Setup
        
        ### Dependencies needed pre-install
        
        * Cython: `pip3 install Cython`
        * numpy: `pip3 install numpy`
        * Tkinter for python3: `sudo apt-get install python3-tk` (for example), 
        * python version 3.6 or higher
        
        ### Install instructions
        
        `pip3 install bfit`
        
        ### Optional seteup
        
        You may want to tell bfit where the data is stored. This is done by defining environment variables
        `BNMR_ARCHIVE` and `BNQR_ARCHIVE` (for convenience add this to your .bashrc script). The expected file format is as follows: 
        
            /path/
                bnmr/
                bnqr/
                    2017/
                    2018/
                        045123.msr
        
        In this example, you would set `BNQR_ARCHIVE=/path/bnqr/` to the directory containing the year directories.
        
        If bfit cannot find the data, it will attempt to download the files from [musr.ca](http://musr.ca/mud/runSel.html) according to the defaults set in the [bdata](https://pypi.org/project/bdata/) package. 
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Cython
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Development Status :: 5 - Production/Stable
Description-Content-Type: text/markdown
