Metadata-Version: 1.1
Name: mrestimator
Version: 0.0.1
Summary: Toolbox for the Multistep Regression Estimator.
Home-page: https://gitlab.gwdg.de/pspitzn/mre
Author: Paul Spitzner
Author-email: paul.spitzner@ds.mpg.de
License: LICENSE
Description: # Mr. Estimator
        
        Welcomme to the Toolbox for the Multistep Regression Estimator
        
        See the [Documentation](https://pspitzn.pages.gwdg.de/mre/) for usage details
        and [how to get started.](https://pspitzn.pages.gwdg.de/mre/rst/gettingstarted.html)
        
        For Details on the estimator itself, see
        [J. Wilting and V. Priesemann, Nat. Commun. 9, 2325 (2018)](https://doi.org/10.1038/s41467-018-04725-4)
        
        ## Requirements
        - Python (3.5)
        - numpy (1.15.0)
        - scipy (1.0.0)
        - matplotlib (1.5.1)
        
        Assuming a working Python3 environment,
        usually you can install the dependencies via pip:
        ```
        pip3 install -U numpy scipy matplotlib
        ```
        
        ## Manual Installation
        
        Clone the repository via ssh or https
        
        ```
        git clone git@github.com:pSpitzner/mrestimator.git
        git clone https://github.com/pSpitzner/mrestimator.git
        ```
        
        And optionally,
        
        ```
        export PYTHONPATH="${PYTHONPATH}:$(pwd)/mrestimator"
        ```
        
        This line adds the downloaded directory to your `PYTHONPATH` environment
        variable, so that it will be found automatically when importing. If you want to add the path
        automatically when you login, you can add it to your `~/.bashrc` or `~/.profile`:
        
        ```
        echo 'export PYTHONPATH="${PYTHONPATH}:'$(pwd)'/mrestimator"' >> ~/.bashrc
        ```
        
        Then, you should be able to import the module into any python session
        
        ```
        python3
        import mrestimator as mre
        ```
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
