Installation

Stable release

To install Cardea, run this command in your terminal:

$ pip install cardea

This is the preferred method to install Cardea, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Cardea can be downloaded from the Github repo.

You can either clone the stable branch form the public repository:

$ git clone --branch stable git://github.com/D3-AI/Cardea

Or download the tarball:

$ curl  -OL https://github.com/D3-AI/Cardea/tarball/stable

Once you have a copy of the source, you can install it with this command:

$ make install

Development Setup

If you want to make changes in Cardea and contribute them, you will need to prepare your environment to do so.

These are the required steps:

1. Fork the Cardea Github repo.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/Cardea.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv Cardea
   $ cd Cardea/
   $ make install-develop
   

Getting Started Quickstart