Installation¶

Find below instructions for either ‘quick and dirty’ way or a neater way of installing emgfit. The second approach is intended for more advanced users that want to keep their Python setup cleaner by using virtual environments.

The quick and dirty way¶

All emgfit versions >= 0.2.0 are available as pip install from PyPI.

Ensure that Python3 and its package installer pip are available on your system and have been added to your PATH (pip comes pre-installed with most Python distributions).
Use your command line to download and install emgfit from PyPI by running:
```
$ pip install --upgrade emgfit
```

The latest version of the package and all its dependencies should now be installed under your Python directory in /Lib/site-packages. If you want to install a specific emgfit version x.y.z run $ pip install emgfit==x.y.z.

To test whether the installation succeeded open Python from your command line and import the package:
```
$ python
$ import emgfit
```

If the second line does not raise any errors you should be good to go with emgfit!

The neater way: Installing emgfit into a virtual environment¶

Find instructions for both conda and pip users below.

For pip users:¶

Ensure that Python3 and its package installer pip are available on your system and have been added to your PATH (pip comes pre-installed with most Python distributions).
Set up a new virtual environment for emgfit to live in. To do so, use your command line to navigate to the folder in which you would like to set up the virtual environment and run the following:
```
$ pip install virtualenv
$ python -m venv emgfit-env
```
Activate the new emgfit-env environment. The command for this depends on your platform.

Windows users run:
```
$ emgfit-env\Scripts\activate.bat
```
Linux users run:
```
$ source emgfit-env/bin/activate
```
Now you are inside your virtual environment and can install emgfit. Download and install emgfit by running:
```
(emgfit-env) $ pip install --upgrade emgfit
```

The latest version of the package and all its dependencies should now be installed inside your virtual environment emgfit-env under /Lib/site-packages. If you want to install a specific emgfit version x.y.z run $ pip install emgfit==x.y.z.

To test whether the installation succeeded open Python from your command line (after activating emgfit-env!) and import the package:
```
(emgfit-env) $ python
(emgfit-env) $ import emgfit
```
If the second line does not raise any errors you should be good to go with emgfit!

For conda users:¶

Ensure that Python3 and its package installer pip are available on your system and have been added to your PATH (pip comes pre-installed with most Python distributions including Anaconda).
Set up a new virtual environment for emgfit to live in by running the following in your command line:
```
$ conda create -n emgfit-env python=3.7
```

Activate the conda environment:

(emgfit-env) $ conda activate emgfit-env

Now you are inside your virtual environment and can install emgfit. Download and install emgfit by running:
```
(emgfit-env) $ python setup.py install
```
The latest version of the package and all its dependencies should now be installed inside your virtual environment emgfit-env under /Lib/site-packages. If you want to install a specific emgfit version x.y.z run $ pip install emgfit==x.y.z.
To test whether the installation succeeded open Python from your command line and import the package:
```
(emgfit-env) $ python
(emgfit-env) $ import emgfit
```
If the second line does not raise any errors you should be good to go with emgfit!

Launching Jupyter notebook¶

To start working with emgfit, start up the Jupyter notebook server using the following command:

$ jupyter notebook

Users that installed emgfit into a virtual environment must first activate their emgfit environment (see step 2 above) before running this command.

This will make a window pop up in your default browser. In there, you can navigate to different directories and create new notebooks (using the new panel on the top right) or open existing ones. Make sure that you use the default kernel (usually called Python3). Once you have imported the emgfit package you should be ready to analyze some data.