Installation¶

Recommended Environments¶

The following versions of Python can be used: 3.4, 3.5, 3.6.

We recommend setting up a virtual environment with Python 3.6 for using or developing CarpeDM.

We use virtualenv, but you could use Conda, etc.

$ virtualenv -p /path/to/python3 ~/.virtualenvs/carpedm
$ source ~/.virtualenvs/carpedm/bin/activate

Or, for Conda:

$ conda create --name carpedm python=3.6
$ conda activate carpedm

Note

CarpeDM is built and tested on MacOS. We cannot guarantee that it works on other environments, including Windows and Linux.

Before installing CarpeDM, we recommend to upgrade setuptools if you are using an old one:

$ pip install -U setuptools

The following Python packages are required to install CarpeDM. The latest version of each package will automatically be installed if missing.

The following packages are optional dependencies.

We recommend installing the latest release of CarpeDM with pip:

$ pip install carpedm

Note

Any optional dependencies can be added after installing CarpeDM. Please refer to Optional Dependencies.

You can install a development version of CarpeDM from a cloned Git repository:

$ git clone https://github.com/SimulatedANeal/carpedm.git
$ cd carpedm
$ python setup.py develop

Using the following (see carpedm.data.meta)

MetaLoader.view_images()
MetaLoader.data_stats(which_stats=('frequency'))

require matplotlib. We recommend installing it with pip:

$ pip install matplotlib

Use pip to uninstall CarpeDM:

$ pip uninstall carpedm

Just use pip with -U option:

$ pip install -U carpedm