Skip to content

Commit

Permalink
Minor doc issues from QA review
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesus89 committed Dec 4, 2020
1 parent 0f1ffae commit 6dece83
Show file tree
Hide file tree
Showing 19 changed files with 38 additions and 45 deletions.
2 changes: 1 addition & 1 deletion docs/examples/data_observatory/access_dataset.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"metadata": {},
"source": [
"### Choose a dataset\n",
"Learn how to discover a dataset through the catalog by checking the [`discovery example`](/developers/cartoframes/examples/#example-discover-a-dataset).\n",
"Learn how to discover a dataset through the catalog by checking the <a href='https://carto.com/developers/cartoframes/examples/#example-data-discovery' target='_blank'>Data Discovery example</a>.\n",
"\n",
"You can also choose a dataset from your subscriptions. Call `Catalog().subscriptions()` to list your active subscriptions."
]
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/data_observatory/google_cloud_credentials.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"source": [
"## Google Cloud credentials\n",
"\n",
"This example illustrates how to create a Google Cloud Platform credentials object from your Data Observatory enabled CARTO account."
"This example illustrates how to create a Google cloud credentials object from your Data Observatory enabled CARTO account."
]
},
{
Expand Down Expand Up @@ -49,7 +49,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"As an example, the following code shows how to use the Google BigQuery client to access to a public Data Observatory dataset:"
"As an example, the following code shows how to use the Google BigQuery client to access to a public dataset from Data Observatory:"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"Read more about Maps API Keys: https://carto.com/developers/auth-api/guides/types-of-API-Keys/\n",
"\n",
"> Note: CARTO Account credentials are needed to reproduce this example. https://carto.com/signup"
">_Note: You'll need [CARTO Account](https://carto.com/signup) credentials to reproduce this example._"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"\n",
"This example illustrate how to publish a layout of map visualizations.\n",
"\n",
"> Note: CARTO Account credentials are needed to reproduce this example. https://carto.com/signup"
">_Note: You'll need [CARTO Account](https://carto.com/signup) credentials to reproduce this example._"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"Read more about Maps API Keys: https://carto.com/developers/auth-api/guides/types-of-API-Keys/\n",
"\n",
"> Note: CARTO Account credentials are needed to reproduce this example. https://carto.com/signup"
">_Note: You'll need [CARTO Account](https://carto.com/signup) credentials to reproduce this example._"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"Read more about API Keys here: https://carto.com/developers/auth-api/guides/types-of-API-Keys/\n",
"\n",
"> Note: CARTO Account credentials are needed to reproduce this example. https://carto.com/signup"
">_Note: You'll need [CARTO Account](https://carto.com/signup) credentials to reproduce this example._"
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/examples.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"categories": [
{
"title": "Use Cases",
"desc": "Explore a variety of ways to use CARTOframes in your workflows",
"desc": "Explore how to make the most of your Spatial Analysis with CARTOframes",
"hide_sidebar_samples": true,
"samples": [
{
Expand Down Expand Up @@ -49,7 +49,7 @@
},
{
"title": "Templates",
"desc": "Explore a variety of ways to use CARTOframes in your workflows",
"desc": "Incorporate CARTOframes in your workflows easily with functionality templates",
"hide_sidebar_samples": true,
"samples": [
{
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/templates/do_access_public_data.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"\n",
"This notebook shows how to use CARTOframes for discovering and downloading **public** datasets from CARTO's [Data Observatory](https://carto.com/spatial-data-catalog/).\n",
"\n",
"For more details please visit the [Guides](https://carto.com/developers/cartoframes/guides). If you'd like further detail on how to discover and explore datasets from the catalog, take a look at [Explore CARTO Data Observatory](/developers/cartoframes/examples/#example-data-discovery) notebook.\n",
"For more details please visit the [Guides](https://carto.com/developers/cartoframes/guides). If you'd like further detail on how to discover and explore datasets from the catalog, take a look at <a href='https://carto.com/developers/cartoframes/examples/#example-data-discovery' target='_blank'>Explore CARTO Data Observatory</a> notebook.\n",
"\n",
"The notebook is organized in the following sections:\n",
" - [Discover datasets applying the public filter](#section1)\n",
Expand Down Expand Up @@ -687,7 +687,7 @@
"\n",
"We select the latest [dataset](https://carto.com/spatial-data-catalog/browser/dataset/acs_sociodemogr_aeb99461/) `acs_sociodemogr_8c2655e0`.\n",
"\n",
"If you'd like to get a description of the dataset, you can use the Dataset functions `to_dict()`, `describe()`, `head()`, and `geom_coverage()`. You can also have access to all its variables as explained on the [Explore CARTO Data Observatory](/developers/cartoframes/examples/#example-data-discovery) notebook."
"If you'd like to get a description of the dataset, you can use the Dataset functions `to_dict()`, `describe()`, `head()`, and `geom_coverage()`. You can also have access to all its variables as explained on the <a href='https://carto.com/developers/cartoframes/examples/#example-data-discovery' target='_blank'>Explore CARTO Data Observatory</a> notebook."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/templates/do_data_discovery.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
" 1.4. [Get a first glimpse of a dataset](#section1.3)\n",
" \n",
" \n",
"**Want to learn more?** Learn how to access and download datasets on the following notebooks [Access Public Data](/developers/cartoframes/examples/#example-access-public-data) and [Access Premium Data](/developers/cartoframes/examples/#example-access-premium-data)."
"**Want to learn more?** Learn how to access and download datasets on the following notebooks <a href='https://carto.com/developers/cartoframes/examples/#example-access-public-data' target='_blank'>Access Public Data</a> and <a href='https://carto.com/developers/cartoframes/examples/#example-access-premium-data' target='_blank'>Access Premium Data</a>."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/templates/do_data_enrichment.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@
"\n",
"We first check that we are subscribed to PB POIs dataset in Spain and download the sports POI's within a bounding box covering Madrid downtown. You can calculate your bounding box of interest using [bboxfinder](http://bboxfinder.com).\n",
"\n",
"For a step by step description on how to discover and download premium datasets, take a look at templates: [Data Discovery](/developers/cartoframes/examples/#example-data-discovery) and [Access Premium Data](/developers/cartoframes/examples/#example-access-premium-data)."
"For a step by step description on how to discover and download premium datasets, take a look at templates: <a href='https://carto.com/developers/cartoframes/examples/#example-data-discovery' target='_blank'>Data Discovery</a> and <a href='https://carto.com/developers/cartoframes/examples/#example-access-premium-data' target='_blank'>Access Premium Data</a>."
]
},
{
Expand Down Expand Up @@ -4377,7 +4377,7 @@
"\n",
"Now, we are interested in getting the number of eating places within a 5-minute isochrone for every sport POI. This requires using a filter to indicate that only eating places should be counted. Filters are added in a dictionary-like format, where the key is the filtering variable and the value is the filtering value.\n",
"\n",
"If you are interested in knowing how to identify the variable to use as filter, check out this [notebook](/developers/cartoframes/examples/#example-access-premium-data) on how to access and download premium data."
"If you are interested in knowing how to identify the variable to use as filter, check out this <a href='https://carto.com/developers/cartoframes/examples/#example-access-premium-data' target='_blank'>notebook</a> on how to access and download premium data."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/use_cases/building_a_dashboard.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
"source": [
"We can get the pharmacies from [Pitney Bowes' Consumer Points of Interest](https://carto.com/spatial-data-catalog/browser/dataset/pb_consumer_po_62cddc04/) dataset. This is a premium dataset, so we first need to check that we are subscribed to it.\n",
"\n",
"Take a look at [this template](/developers/cartoframes/examples/#example-access-premium-data) for more details on how to access and download a premium dataset."
"Take a look at <a href='#example-access-premium-data' target='_blank'>this template</a> for more details on how to access and download a premium dataset."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/use_cases/combining_two_datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
"\n",
"In this section, we'll download the two datasets we're interested in and combine them into a single dataframe.\n",
"\n",
"For more information on how to access Data Observatory datasets using CARTOframes visit the [Guides](/developers/cartoframes/guides/) or take a look at the [Access Premium Data](/developers/cartoframes/examples/#example-access-premium-data) template."
"For more information on how to access Data Observatory datasets using CARTOframes visit the [Guides](https://carto.com/developers/cartoframes/guides/) or take a look at the <a href='https://carto.com/developers/cartoframes/examples/#example-access-premium-data' target='_blank'>Access Premium Data</a> template."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/use_cases/paris_wifi_services.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Read local data from a json file"
"Read local data from a JSON file"
]
},
{
Expand Down
10 changes: 5 additions & 5 deletions docs/guides/01-Installation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
"source": [
"### System requirements\n",
"\n",
"#### Operating System\n",
"#### Operating system\n",
"\n",
"Windows, macOS, GNU/Linux\n",
"\n",
"#### Python Interpreter\n",
"#### Python interpreter\n",
"\n",
"Python 3.5+ (previous versions are not supported)\n",
"\n",
Expand All @@ -31,7 +31,7 @@
"\n",
"If you don't have Python installed, please install the latest version from [python.org](https://python.org/) or refer to the [Installing Python guide](https://docs.python-guide.org/starting/installation/).\n",
"\n",
"#### Python Environments\n",
"#### Python environments\n",
"\n",
"Although installing a Python environment is not strictly required, it's highly recommended to have cleaner and more organized installations. You can check the tutorial on [Creating Virtual Environments](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) or [Managing Conda Environments](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)."
]
Expand Down Expand Up @@ -71,7 +71,7 @@
"[RTree](https://github.com/Toblerity/rtree) is a spatial index package to improve performance and is required for overlay operations. It provides an interface to [libspatialindex](https://github.com/libspatialindex/libspatialindex).\n",
"\n",
"\n",
"#### Windows Users\n",
"#### Windows users\n",
"\n",
"CARTOframes needs that [Shapely](https://github.com/Toblerity/Shapely) and [Fiona](https://github.com/Toblerity/Fiona) libraries are already installed in your system. Execute these commands to install CARTOframes correctly:\n",
"```bash\n",
Expand Down Expand Up @@ -100,7 +100,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### About Metrics\n",
"### About metrics\n",
"\n",
"We collect data on the usage of CARTOframes to improve the library. Usage data includes information like \"map_created,\" which is the event triggered when a map is created. The collected usage data is anonymous and it does not contain the data processed, just the information of the event, and it's handled in accordance with our Privacy Notice <https://carto.com/privacy/> .\n",
"You may choose to opt out by calling `cartoframes.utils.setup_metrics(False)`."
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/02-Authentication.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
"\n",
"CARTO [Data Observatory](/developers/cartoframes/guides/Data-Observatory/) is built on top of Google BigQuery, so every CARTO Enterprise organization has an associated Google Cloud account to run Data Observatory operations.\n",
"\n",
"In case you have an Enterprise account, and want to performs data operations directly with the Python BigQuery client, you can obtain the credentials of the associated Google Cloud account and create a Google Credentials instance."
"In case you have an Enterprise account and want to perform data operations directly with the Python BigQuery client, you can obtain the credentials of the associated Google Cloud account and create a Google Credentials instance."
]
},
{
Expand Down
8 changes: 4 additions & 4 deletions docs/guides/03-Quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@
"\n",
"To begin, let's outline a workflow:\n",
"\n",
"- Get and explore your company's data\n",
"- Get and explore your own data\n",
"- Create areas of influence for your stores\n",
"- Enrich your data with demographic data\n",
"- Enrich your data\n",
"- And finally, share the results of your analysis with your team\n",
"\n",
"Let's get started!"
Expand All @@ -51,7 +51,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Get and explore your company's data\n",
"### Get and explore your own data\n",
"\n",
"We are going to use a dataset that contains information about the location of Starbucks and each store's annual revenue.\n",
"\n",
Expand Down Expand Up @@ -4298,7 +4298,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Enrich your data with demographic data\n",
"### Enrich your data\n",
"\n",
"Now that you have the area of influence calculated for each store, let's take a look at how to augment the result with population information to help better understand a store's average revenue per person.\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/04-Data-Management.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"source": [
"### Read a GeoJSON file\n",
"\n",
"It shows how to load geographic data from a GeoJSON file using [GeoPandas](https://geopandas.org/). To read pure JSON files check this [example]()."
"It shows how to load geographic data from a GeoJSON file using [GeoPandas](https://geopandas.org/). To read pure JSON files check this [example](/developers/cartoframes/examples/#example-read-a-json-file)."
]
},
{
Expand Down
19 changes: 2 additions & 17 deletions docs/guides/07-Data-Observatory.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"\n",
"Datasets are organized in these main hierarchies: country, category, provider and geography (or spatial resolution).\n",
"\n",
"> The catalog is public and you don't need a CARTO account to search for available datasets. You can access our web catalog here: https://carto.com/spatial-data-catalog/"
"> The catalog is public and you don't need a CARTO account to search for available datasets. You can access our web catalog here: [https://carto.com/spatial-data-catalog](https://carto.com/spatial-data-catalog)"
]
},
{
Expand Down Expand Up @@ -2443,22 +2443,7 @@
"cell_type": "code",
"execution_count": 17,
"metadata": {},
"outputs": [
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "de036e4308ec4cdba6a093b2236bd42f",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"HTML(value='\\n <h3>Subscription already purchased</h3>\\n The dataset <b>carto-do.ags.demographic…"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"outputs": [],
"source": [
"dataset.subscribe()"
]
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/viz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,11 @@ Popups
:noindex:
:members: popup_element,
default_popup_element

Publications
^^^^^^^^^^^^

.. automodule:: cartoframes.viz
:noindex:
:members: all_publications,
delete_publication

0 comments on commit 6dece83

Please sign in to comment.