CartoFramesGettingStarted

GettingStarted.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Welcome to CARTOFrames\n",
    "\n",
    "Thanks for trying out CARTOFrames! We are really excited to integrate CARTO with the rest of yout data science stack. \n",
    "\n",
    "On this notebook server you will find a series of example notebooks showing how to use CARTOFrames in a number of different situations. \n",
    "\n",
    "## API Keys \n",
    "\n",
    "To run these examples, you will need a CARTO API key. If you dont currently have one for your own account dont worry we supply one here. In a notebook simply access the environmnet variable CARTO_API_KEY and CARTO_TEST_USER like so \n",
    "\n",
    "```python\n",
    "\timport os\n",
    "\tapi_key  = os.environ[\"CARTO_API_KEY\"]\n",
    "\tusername = os.environ[\"CARTO_TEST_USER\"]\n",
    "```\n",
    "\n",
    "This will give you access to a shared CARTO account where all the testers of CARTOFrames have access. Datasets on this account are subject to deletion at any time and will be publicly viewable by anyone so please be advised not to put anything sensitive on there.\n",
    "\n",
    "## Bugs issues and feature requests\n",
    "\n",
    "If while using CARTOFrames either on this trial server or on your own machine, please head over to our [github repo](https://github.com/CartoDB/cartoframes) and file an issue there. Pull requests are also very welcome!\n",
    "\n",
    "## Documentation \n",
    "\n",
    "All the docs for CARTOFrames can be found at this [link](https://cartodb.github.io/cartoframes/)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Examples \n",
    "\n",
    "- [Basic Usage](examples/Basic%20Usage.ipynb) - Some basic guidance on how to use CARTOFrames\n",
    "- [Dask](examples/cartoframes-and-dask.ipynb) - How to integrate CARTOFrames with distributed computing systems like Dask.\n",
    "- [Geopandas](examples/Shapely%2C%20Geopandas%2C%20and%20Cartoframes.ipynb) - See how CARTOFrames plays well with geopandas and shapl"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}