Skip to content

Commit 93a31af

Browse files
authored
Added iPynb notebooks and fixed issue #67 (#86)
* Added notebooks * Added --upgrade flag * Update requirements and setup.py * Added maintenance information to the readme
1 parent b93ce20 commit 93a31af

10 files changed

Lines changed: 7765 additions & 10 deletions

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ from `pip`.
3737

3838
.. code-block:: bash
3939
40-
$ pip install git+https://github.com/google/datacommons.git@stable-1.x
40+
$ pip install -U git+https://github.com/google/datacommons.git@stable-1.x
4141
4242
Once the package is installed, you can import the :code:`datacommons` package in
4343
Python.

docs/source/started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ First, install the :code:`datacommons` package through :code:`pip`.
1616

1717
.. code-block:: bash
1818
19-
$ pip install git+https://github.com/google/datacommons.git@stable-1.x
19+
$ pip install -U git+https://github.com/google/datacommons.git@stable-1.x
2020
2121
For more information about installing :code:`pip` and setting up other parts of
2222
your Python development environment, please refer to the

notebooks/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Python Client API Notebooks
2+
3+
This directory contains iPython notebooks that use the Python Client API to
4+
perform various statistical analyses on interesting datasets. You can click on
5+
each link to see a live colab version.
6+
7+
Notebook | Description
8+
-------- | -----------
9+
[`getting_started.ipynb`](https://colab.research.google.com/drive/1ZNXTHu3J0W3vo9Mg3kNUpk0hnD6Ce1u6) | A tutorial that demonstrates various functions supported by the Data Commons API through the task of plotting employment data from the [Bureau of Labor Statistics](https://www.bls.gov/).
10+
[`analyzing_census_data.ipynb`](https://colab.research.google.com/drive/1qCPZZD0MPWx6CC34wFVJc_9B2-q0F-h_) | A notebook that analyzes the relationship between population size and median age for each State, County, and City in the United States.
11+
[`analyzing_income_distribution.ipynb`](https://colab.research.google.com/drive/1uZtHeQ5FJoKPdjYjaHnIPXcAe0nKLcKO) | A notebook that plots the distribution of income using statistics provided by the 2017 [American Community Survey](https://www.census.gov/programs-surveys/acs). The final result is a histogram charting the number of individuals in income brackets ranging from "0 to 10,000USD" up to "Above 200,000USD".
12+
[`analyzing_obesity_prevalence.ipynb`](https://colab.research.google.com/drive/1cawpFQzuoRcZX0H_kpbBvhBNZzGjBN8t) | A notebook that analyzes the relationship between prevalence of obesity in 500 US Cities (as provided by the [CDC Wonder](https://wonder.cdc.gov/) dataset) to health and socio-economic indicators such as prevalence of high blood pressure and poverty rate.
13+
[`analyzing_education_achievement.ipynb`](https://colab.research.google.com/drive/1-FlOBVOdcWE4BK1bhhix1jv0-RU5bQ6a) | A notebook that analyzes the relationship between student achievement in the 3rd, 5th, and 8th grade (as provided by [SEDA](https://cepa.stanford.edu/seda/overview)) and various socio-contextual indicators such as crime rate and nativity.
14+
15+
## Maintenance
16+
17+
To maintain up to date versions of these notebooks, developers can save a copy
18+
of the above notebooks to a GitHub repository and PR this repository. Navigate
19+
to `File > Save a copy in GitHub...`
20+
21+
![How to save to a GitHub repository.](https://user-images.githubusercontent.com/4650701/62900477-10787680-bd0f-11e9-84d0-ee69f8c17df9.png)

0 commit comments

Comments
 (0)