Skip to content

Commit 9a3dbc4

Browse files
brian-rosepre-commit-ci[bot]kafitzgerald
authored
Better overviews (#650)
* Add Overview heading * Fixed overview for Getting Started with Python * Narrative overview for intermediate numpy * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fix some broken links * One more xarray link fix * Narrative overviews for matplotlib chapters * narrative overview for pandas * Narrative overviews for git and github * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update with better cross-referencing to our lessons * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Clarify in template that ordered topic list is optional * Update core/matplotlib/histograms-piecharts-animation.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update core/numpy/intermediate-numpy.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update core/pandas/pandas.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update core/matplotlib/annotations-colorbars-layouts.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update core/matplotlib/matplotlib-basics.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update foundations/github/basic-git.md Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update foundations/github/what-is-github.md Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update foundations/github/github-pull-request.md Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update foundations/github/github-repos.md Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update foundations/github/git-workflows.md Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Fix workflow capitalization * Update core/matplotlib/matplotlib-basics.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update core/xarray/dask-arrays-xarray.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> * Update core/xarray/xarray-intro.ipynb Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com>
1 parent 3d97326 commit 9a3dbc4

26 files changed

Lines changed: 75 additions & 102 deletions

appendix/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ discussions
4747
documentation
4848
: Software documentation is descriptive content (e.g., text, images, videos) that is either embedded in the software code or distributed alongside the corresponding software.
4949

50-
Feature Branch Workflow
50+
feature branch workflow
5151
: A collaborative development workflow where new development takes place on dedicated branches rather than the main branch.
5252

5353
fork
5454
: A copy of another project hosted on a collaborative development platform such as {term}`GitHub`.
5555

56-
Forking Workflow
56+
forking workflow
5757
: A collaborative development workflow where new development takes place on forked repositories rather than the main project repository.
5858

5959
free and open-source software

appendix/how-to-contribute.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
General information on how to contribute to any Project Pythia repository
44
may be found in the [Contributing to Project Pythia](https://projectpythia.org/contributing) guide.
55

6-
As GitHub Pull Requests are an important part of contributing to Pythia, this guide will cross-reference tutorials on GitHub and Pull Requests.
6+
As GitHub {term}`pull request`s are an important part of contributing to Pythia, this guide will cross-reference tutorials from our chapters on [Getting Started with GitHub](../foundations/getting-started-github.md).
77

8-
If you need to comment on anything in Pythia Foundations you feel needs work, you can use the "open issue" or "suggest edit" buttons at the top of any Pythia Foundations page. These buttons appear when you hover over the GitHub Octocat logo. Clicking on these buttons will take you to the relevant page on GitHub, where the entirety of the Pythia Foundations material is hosted. In order to actually suggest changes, you must have a free GitHub account, as listed in the GitHub section of Pythia Foundations. This guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main guide for [Contributing to Project Pythia](https://projectpythia.org/contributing).
8+
A quick and easy way to find the Pythia Foundations source repository on GitHub while you are browsing the book is to look for the GitHub Octocat logo near the top right of each page. This will link directly to our [main source repository on GitHub](https://github.com/ProjectPythia/pythia-foundations).
9+
10+
In order to [open issues](../foundations/github/github-issues.md) or create [pull requests](../foundations/github/github-pull-request.md) to suggest changes, you must have a [free GitHub account](../foundations/github/what-is-github.md). This guide is strictly for Pythia Foundations; for general Project Pythia contribution guidelines, see the main guide for [Contributing to Project Pythia](https://projectpythia.org/contributing).
911

1012
To quickly provide feedback about minor issues without the use of GitHub, you can also use this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSeVa1TC9xM-dk7qIE2e8bsgSrIP82yYDNw3wew3J46eREJa4w/viewform?usp=sf_link).
1113

appendix/template.ipynb

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,17 @@
4040
"metadata": {},
4141
"source": [
4242
"## Overview\n",
43-
"If you have an introductory paragraph, lead with it here! Keep it short and tied to your material, then be sure to continue into the required list of topics below,\n",
43+
"If you have an introductory paragraph, lead with it here! Keep it short and tied to your material.\n",
44+
"\n",
45+
"Optionally, you can include an ordered list of topics like these.\n",
4446
"\n",
4547
"1. This is a numbered list of the specific topics\n",
4648
"1. These should map approximately to your main sections of content\n",
4749
"1. Or each second-level, `##`, header in your notebook\n",
4850
"1. Keep the size and scope of your notebook in check\n",
49-
"1. And be sure to let the reader know up front the important concepts they'll be leaving with"
51+
"1. And be sure to let the reader know up front the important concepts they'll be leaving with\n",
52+
"\n",
53+
"This list is not always needed, since an in-page navigation bar using your section headings will be created automatically when the book is rendered."
5054
]
5155
},
5256
{

core/matplotlib/annotations-colorbars-layouts.ipynb

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,7 @@
1212
"---\n",
1313
"## Overview\n",
1414
"\n",
15-
"In this section we explore methods for customizing plots. The following topics will be covered:\n",
16-
"\n",
17-
"1. Adding annotations\n",
18-
"1. Rendering equations\n",
19-
"1. Colormap overview \n",
20-
"1. Basic colorbars \n",
21-
"1. Shared colorbars\n",
22-
"1. Custom colorbars\n",
23-
"1. Mosaic subplots"
15+
"In this chapter we explore some more advanced methods for customizing plots. We will start with adding **text annotations** and **rendered math** with LaTeX. We then explore some details of **colormaps** and **colorbar** customization. Finally, we take a look at the **mosaic subplot**, a simple method for customizing the layout of multi-plot figures."
2416
]
2517
},
2618
{

core/matplotlib/histograms-piecharts-animation.ipynb

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,7 @@
1818
"---\n",
1919
"## Overview\n",
2020
"\n",
21-
"In this section we'll explore some more specialized plot types, including:\n",
22-
"\n",
23-
"1. Histograms\n",
24-
"1. Pie Charts\n",
25-
"1. Animations"
21+
"In this chapter we'll explore some more specialized plot types, including **histograms** and **pie charts**. We will then introduce Matplotlib's **animation** toolkit, which lets us create animations from functions."
2622
]
2723
},
2824
{

core/matplotlib/matplotlib-basics.ipynb

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,11 @@
1616
"metadata": {},
1717
"source": [
1818
"## Overview\n",
19-
"We will cover the basics of using the Matplotlib {cite:p}`Hunter:2007` library to create plots in Python, including a few different plots available within the library. This page is laid out as follows:\n",
20-
"\n",
21-
"1. Why Matplotlib?\n",
22-
"1. Figure and axes\n",
23-
"1. Basic line plots\n",
24-
"1. Labels and grid lines\n",
25-
"1. Customizing colors\n",
26-
"1. Subplots\n",
27-
"1. Scatterplots\n",
28-
"1. Displaying Images\n",
29-
"1. Contour and filled contour plots."
19+
"This chapter will cover the basics of using the Matplotlib {cite:p}`Hunter:2007` library to create plots in Python. \n",
20+
"\n",
21+
"We will start with the core Matplotlib concepts of **Figures** and **Axes**. We'll then make some basic **line plots** from arrays of data and walk through some customization options like **labels**, **grid lines**, and **colors**. Next, we will discuss combining multiple plots into a single figure with **subplots** and show how to share an axis between two plots.\n",
22+
"\n",
23+
"Finally, we will explore some other common plot types, including **scatterplots**, **image** plots, and **contour** plots."
3024
]
3125
},
3226
{

core/numpy/intermediate-numpy.ipynb

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@
1919
"metadata": {},
2020
"source": [
2121
"## Overview\n",
22-
"1. Working with multiple dimensions\n",
23-
"1. Subsetting of irregular arrays with booleans\n",
24-
"1. Sorting, or indexing with indices"
22+
"\n",
23+
"This chapter will introduce some of NumPy's more advanced capabilities, with a focus on using indexing operations to manipulate arrays of numbers. We'll look first at basic ordered indexing of arrays with multiple dimensions and some vector operations. Then we'll look at subsetting arrays using boolean logic and finally using array indexing operations for sorting and subsetting."
2524
]
2625
},
2726
{

core/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ greatly simplifies the code development process (read: less lines of code).
7474

7575
One of the limitations of Pandas
7676
is that it’s only able to handle one- or two-dimensional (i.e. tabular) data arrays.
77-
The [Xarray](http://xarray.pydata.org/) library was therefore created
77+
The [Xarray](https://docs.xarray.dev/) library was therefore created
7878
to extend the labelled array concept to N-dimensional arrays:
7979

8080
![Xarray Dataset schematic](https://github.com/pydata/xarray/blob/5f670a74392e3b625dba283c75c6dc2a43be808b/doc/_static/dataset-diagram.png)

core/pandas/pandas.ipynb

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@
2121
"metadata": {},
2222
"source": [
2323
"## Overview\n",
24-
"1. Introduction to pandas {cite:p}`reback2020pandas` data structures\n",
25-
"1. How to slice and dice pandas dataframes and dataseries\n",
26-
"1. How to use pandas for exploratory data analysis\n",
24+
"\n",
25+
"This chapter starts with an introduction to the core pandas {cite:p}`reback2020pandas` structures for labeled tabular data, the `DataFrame` and the `Series`. We will load in some example time series data and explore basic methods for slicing and dicing the data with pandas. We then dig into some exploratory data analysis, including basic statistics, quick plotting, resampling in time, and applying operations to data in a `DataFrame`.\n",
2726
"\n",
2827
"## Prerequisites\n",
2928
"\n",

core/xarray.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ You should have a basic familiarity with [Numpy arrays](numpy.md) prior to worki
2020
3 hours
2121
:::
2222

23-
[xarray home]: http://xarray.pydata.org/en/stable/
23+
[xarray home]: https://docs.xarray.dev/en/stable/

0 commit comments

Comments
 (0)