mrestimator 0.1.3

Toolbox for the Multistep Regression Estimator.

Mr. Estimator

Welcome to the Toolbox for the Multistep Regression Estimator ("Mister Estimator").

This is work in progress! If you find bugs, encounter unexpected behaviour or want to comment, please let us know or open an issue. Any input is greatly appreciated.

• Documentation
• Getting Started
• Python Package index
• Github
• Details on the estimator: J. Wilting and V. Priesemann, Nat. Commun. 9, 2325 (2018)

Requirements

• Python (>=3.5)
• numpy (>=1.11.0)
• scipy (>=1.0.0)
• matplotlib (>=1.5.3)

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.

Installation

Assuming a working Python3 environment, usually you can install via pip:

pip3 install -U mrestimator

If you run into problems during installation, they are most likely due to numpy and scipy. You may check the official scipy.org documentation 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, 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.

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.1b1, writing to /tmp/mre_output/

Manual Installation

Clone the repository via ssh or https

git clone [e-mail]: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