CARTOframes

A Python package for integrating CARTO maps, analysis, and data services into data science workflows.

Installation

This guide is intended for those who are using CARTOframes for the first time and provides the steps to install it locally, in a Jupyter Notebook, or using a Virtual Environment.

Install CARTOframes using pip

CARTOframes can be installed with pip by simply typing one of the following commands to do a system install:

To install the latest pre release (recommended), use the –pre flag:

1
$ pip install cartoframes --pre

To install the latest stable version (soon to be deprecated):

1
$ pip install cartoframes

To install a specific version, let’s say the 1.0rc1 version:

1
$ pip install cartoframes==1.0rc1

Install CARTOframes in a Jupyter Notebook

In the CARTOframes Developer Center, all of the examples are created with Jupyter Notebooks. If you aren’t familiar with Jupyter Notebooks, we recommend reading the beginner documentation to get familiar with the environment.

To install CARTOframes through a Jupyter Notebook, run this command:

1
! pip install cartoframes --pre

Use a Virtual Environment

We recommend installing CARTOframes in a Virtual Environment, since they are very useful when working with Python locally. This section provides the necessary information to create a simple Virtual Environment and install CARTOframes inside of it:

1
2
3
$ virtualenv cartoframes_env
$ source cartoframes_env/bin/activate
(cartoframes_env) $ pip install cartoframes --pre

To install a specific version:

1
2
3
$ virtualenv cartoframes_env
$ source cartoframes_env/bin/activate
(cartoframes_env) $ pip install cartoframes==1.0rc1

When the virtual environment is activated, it is visible in the command line prompt, in this case: (cartoframes_env). It can be deactivated by typing deactivate to exit the virtualenv:

1
(cartoframes_env) $ deactivate