Metadata-Version: 2.1
Name: mrestimator
Version: 0.1.6
Summary: Toolbox for the Multistep Regression Estimator.
Home-page: https://github.com/Priesemann-Group/mrestimator
Author: The Priesemann Group
Author-email: paul.spitzner@ds.mpg.de
License: BSD
Description: # Mr. Estimator
        
        [![Latest Version](https://img.shields.io/pypi/v/mrestimator.svg)](https://pypi.python.org/pypi/mrestimator/)
        [![Documentation](https://readthedocs.org/projects/mrestimator/badge/?version=latest&style=flat)](https://mrestimator.readthedocs.io/en/latest/)
        [![License](https://img.shields.io/pypi/l/mrestimator.svg)](https://opensource.org/licenses/BSD-3-Clause)
        [![Supported Python Versions](https://img.shields.io/pypi/pyversions/mrestimator.svg)](https://pypi.python.org/pypi/mrestimator/)
        
        Welcome to the Toolbox for the Multistep Regression Estimator ("Mister Estimator").
        
        If you find bugs, encounter unexpected behaviour or want to comment, please let us know via mail or open an issue on github. Any input is greatly appreciated.
        
        - [Documentation](https://mrestimator.readthedocs.io/en/latest/)
        - [Getting Started](https://mrestimator.readthedocs.io/en/latest/doc/gettingstarted.html)
        - [Python Package index](https://pypi.org/project/mrestimator)
        - [Github](https://github.com/Priesemann-Group/mrestimator)
        - Details on the multistep regression estimator: [J. Wilting and V. Priesemann, Nat. Commun. 9, 2325 (2018)](https://doi.org/10.1038/s41467-018-04725-4)
        
        
        ## Dependencies
        - Python (>=3.5)
        - numpy (>=1.11.0)
        - scipy (>=1.0.0)
        - matplotlib (>=1.5.3)
        
        ## Optional Dependencies
        - numba (>=0.44), for parallelization
        - tqdm, for progress bars
        
        We recommend (and develop with) the latest stable versions of the dependencies, at the time of writing that is
        Python 3.7.0, numpy 1.15.1, scipy 1.1.0 and matplotlib 2.2.3.
        
        
        ## What's new
        
        ### [v0.1.6](https://pypi.org/project/mrestimator/0.1.6) (23.04.2020)
        
        This is a cleanup version that tries to be consistent with the paper (in prep). See the [full changelog](https://mrestimator.readthedocs.io/en/latest/doc/changelog.html).
        
        
        ## Installation
        Assuming a working Python3 environment, usually you can install via pip:
        
        ```
        pip3 install mrestimator
        ```
        
        To install (or update an existing installation) with optional dependecies:
        
        ```
        pip3 install -U 'mrestimator[full]'
        ```
        
        If you run into problems during installation, they are most likely due to numpy and scipy.
        You may check the [official scipy.org documentation](https://scipy.org/install.html) or try using anaconda as outlined below.
        
        ### Install Using Anaconda
        
        We sincerely recommend using conda, more so if you are unsure about the dependencies on your system or lack administrator priviliges. It is easy to install, allows you to manage different versions of Python and if something breaks, you can role back and reinstall easily - all without leaving your user directory.
        
        Head over to [anaconda.com](https://www.anaconda.com/download/), and download the installer for Python 3.7.
        
        After following the installation instructions (default settings are fine for most users),
        start a new python session by typing ```python``` in a new terminal window.
        You will see something similar to the following:
        
        ```
        Python 3.7.0 (default, Jun 28 2018, 07:39:16)
        [Clang 4.0.1 (tags/RELEASE_401/final)] :: Anaconda, Inc. on darwin
        Type "help", "copyright", "credits" or "license" for more information.
        >>>
        ```
        
        End the session (```exit()``` or Ctrl-D) and type ```conda list```, which will output a list of the packages that came bundled with anaconda.
        All dependencies for Mr. Estimator are included.
        
        Optionally, you can create a new environment (e.g. named 'myenv') for the toolbox ```conda create --name myenv```
        and activate it with ``source activate myenv`` (``activate myenv`` on windows).
        For more details on managing environments with conda, see [here](https://conda.io/docs/user-guide/tasks/manage-environments.html).
        
        Now install using pip: ```pip install mrestimator``` and afterwards you should be able to import the module into any python3 session
        
        ```
        python
        >>> import mrestimator as mre
        INFO     Loaded mrestimator v0.1.6, writing to /tmp/mre_paul/
        ```
        
        ### Manual Installation
        
        Clone the repository via ssh or https
        
        ```
        git clone git@github.com:Priesemann-Group/mrestimator.git
        git clone https://github.com/Priesemann-Group/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
        ```
        
        ### Pre-release versions
        
        You can upgrade to pre-release versions using pip
        
        ```
        pip install -U --pre 'mrestimator[full]'
        ```
        
        To revert to the stable version, run
        
        ```
        pip install mrestimator==0.1.6
        ```
        
        or
        
        ```
        pip install --force-reinstall mrestimator
        ```
        
        for a complete (longer) reinstall of all dependencies.
        
        ### Parallelization and running on clusters
        
        Per default, the toolbox and its dependencies use all threads available on the host machine.
        While this is great if running locally, it is undesired for distributed computing as the workload manager expects jobs of serial queues to only use one thread.
        To disable multi-threading, you can set the following environment variables (e.g. at the beginning of a job file)
        
        ```
        export OPENBLAS_NUM_THREADS=1
        export MKL_NUM_THREADS=1
        export NUMEXPR_NUM_THREADS=1
        export OMP_NUM_THREADS=1
        export NUMBA_NUM_THREADS=1
        ```
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.5.0
Description-Content-Type: text/markdown
Provides-Extra: full
Provides-Extra: numba
