Skip to content

Commit e8ff5e2

Browse files
Language edits in the Introduction section of the Core Package Overview (ProjectPythia#457)
* Update README.md * Edited the introduction to the overview. The current introduction talks about a stack. I understand the intention of teaching new students a lingo, but no overview about libraries is given. My current edit can help students get an understanding of what content follows. * Revert "Update README.md" This reverts commit 50afbdb. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Making the introduction more welcoming! --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent de17f85 commit e8ff5e2

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

core/numpy/numpy-basics.ipynb

+16-3
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
"metadata": {},
1515
"source": [
1616
"## Overview\n",
17-
"NumPy is the fundamental package for scientific computing with Python. It contains among other things:\n",
17+
"Welcome to your first Python library - NumPy! NumPy is the fundamental package for numerical operations with Python. It contains among other things:\n",
1818
"\n",
1919
"- a powerful N-dimensional array object\n",
2020
"- sophisticated (broadcasting) functions\n",
2121
"- useful linear algebra, Fourier transform, and random number capabilities\n",
2222
"\n",
23-
"The NumPy array object is the common interface for working with typed arrays of data across a wide-variety of scientific Python packages. NumPy also features a C-API, which enables interfacing existing Fortran/C/C++ libraries with Python and NumPy. In this notebook we will cover\n",
23+
"Let's get you started with the basics! In this notebook we will cover\n",
2424
"\n",
2525
"1. Creating an `array`\n",
2626
"1. Math and calculations with arrays\n",
@@ -1025,7 +1025,20 @@
10251025
"name": "python",
10261026
"nbconvert_exporter": "python",
10271027
"pygments_lexer": "ipython3",
1028-
"version": "3.10.2"
1028+
"version": "3.7.15"
1029+
},
1030+
"toc": {
1031+
"base_numbering": 1,
1032+
"nav_menu": {},
1033+
"number_sections": true,
1034+
"sideBar": true,
1035+
"skip_h1_title": false,
1036+
"title_cell": "Table of Contents",
1037+
"title_sidebar": "Contents",
1038+
"toc_cell": false,
1039+
"toc_position": {},
1040+
"toc_section_display": true,
1041+
"toc_window_display": false
10291042
},
10301043
"toc-autonumbering": false
10311044
},

core/overview.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Overview
22

3-
A group of programs that works in tandem to produce a result or achieve a common goal is often referred to as a software stack.
4-
This page gives an overview of the Python geoscience stack.
5-
Scroll to the end of the page for cross-referenced tutorial material for several of the packages in the stack.
6-
We suggest that new users start with the [Foundational Skills](../foundations/overview) section in order to get the most out of these tutorials.
3+
As you might know by now that Python is a programming language. To make your job easier, developers of this programming language provide users like you with libraries (or packages). Core libraries will help you with fundamental numerical functions, and high-level libraries will help you efficiently analyze and visualize your data. Some of these libraries are used all across the Python community, while others are domain-specific. Read below to learn more about core and high-level libraries, and domain-specific libraries of the geoscience community. We suggest that new users start with the [Foundational Skills](../foundations/overview) section in order to get the most out of the tutorials below.
74

85
## Core libraries
96

0 commit comments

Comments
 (0)