2. Install

Fuefit-0.0.7-alpha.1 runs on Python-3.3+, and it is distributed on Wheels.

Note

This project depends on the numpy/scipy, pandas and win32 python-packages that themselfs require the use of C and Fortran compilers to build from sources. To avoid this hussle, you can choose instead one of the methods below:

a self-wrapped python distribution like Anaconda/miniconda, Winpython, or Canopy.

Tip

  • Under Windows you can try the self-wrapped WinPython distribution, a higly active project, that can even compile native libraries using an installations of Visual Studio, if available (required for instance when upgrading numpy/scipy, pandas or matplotlib with pip).

    Just remember to Register your WinPython installation after installation and add your installation into PATH (see Frequently Asked Questions):

    • To register it, go to Start menu ‣ All Programs ‣ WinPython ‣ WinPython ControlPanel, and then Options ‣ Register Distribution .
    • For the path, add or modify the registry string-key [HKEY_CURRENT_USEREnvironment] "PATH".

  • An alternative scientific python-environment is the Anaconda cross-platform distribution (Windows, Linux and OS X), or its lighter-weight alternative, miniconda.

    On this environment you will need to install this project’s dependencies manually using a combination of conda and pip commands. See requirements/miniconda.txt, and peek at the example script commands in .travis.yaml.

  • Check for alternative installation instructions on the various python environments and platforms at the pandas site.

See Install for more details

Before installing it, make sure that there are no older versions left over. So run this console-command (using cmd.exe in windows) until you cannot find any project installed:

$ pip uninstall fuefit                                      ## Use `pip3` if both python-2 & 3 are in PATH.

You can install the project directly from the |pypi|_ the “standard” way, by typing the pip in the console:

$ pip install fuefit

  • If you want to install a pre-release version (the version-string is not plain numbers, but ends with alpha, beta.2 or something else), use additionally --pre.

  • If you want to upgrade an existing installation along with all its dependencies, add also --upgrade (or -U equivalently), but then the build might take some considerable time to finish. Also there is the possibility the upgraded libraries might break existing programs(!) so use it with caution, or from within a |virtualenv|_.

  • To install an older version issue the console-command:

    $ pip install fuefit=1.1.1                    ## Use `--pre` if version-string has a build-suffix.

  • To install it for different Python environments, repeat the procedure using the appropriate python.exe interpreter for each environment.

  • Tip

    To debug installation problems, you can export a non-empty DISTUTILS_DEBUG and distutils will print detailed information about what it is doing and/or print the whole command line when an external program (like a C compiler) fails.

After a successful installation, it is important that you check which version is visible in your PATH, so type this console-command:

$ fuefit --version
0.0.7-alpha.1

2.1. Installing from sources (for advanced users familiar with git)

If you download the sources you have more options for installation. There are various methods to get hold of them:

  • Download and extract a release-snapshot from github.

  • Download and extract a sdist source distribution from |pypi|_.

  • Clone the git-repository at github. Assuming you have a working installation of git you can fetch and install the latest version of the project with the following series of commands:

    $ git clone "https://github.com/ankostis/fuefit.git" fuefit.git
$ cd fuefit.git
$ python setup.py install                                 ## Use `python3` if both python-2 & 3 installed.

When working with sources, you need to have installed all libraries that the project depends on. Particularly for the latest WinPython environments (Windows / OS X) you can install the necessary dependencies with:

$ pip install -r requirements/execution.txt .

The previous command installs a “snapshot” of the project as it is found in the sources. If you wish to link the project’s sources with your python environment, install the project in development mode:

$ python setup.py develop

Note

This last command installs any missing dependencies inside the project-folder.

2.2. Anaconda install

The installation to Anaconda (ie OS X) works without any differences from the pip procedure described so far.

To install it on miniconda environment, you need to install first the project’s native dependencies (numpy/scipy), so you need to download the sources (see above). Then open a bash-shell inside them and type the following commands:

$ coda install `cat requirements/miniconda.txt`
$ pip install lmfit             ## Workaround lmfit-py#149
$ python setup.py install
$ fuefit --version
0.0.7-alpha.1

2.3. Discussion