Skip to content

Commit

Permalink
Language edits in the Introduction section of the Core Package Overvi…
Browse files Browse the repository at this point in the history
…ew (#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>
  • Loading branch information
himahuja and pre-commit-ci[bot] committed Apr 10, 2024
1 parent de17f85 commit e8ff5e2
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
19 changes: 16 additions & 3 deletions core/numpy/numpy-basics.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
"metadata": {},
"source": [
"## Overview\n",
"NumPy is the fundamental package for scientific computing with Python. It contains among other things:\n",
"Welcome to your first Python library - NumPy! NumPy is the fundamental package for numerical operations with Python. It contains among other things:\n",
"\n",
"- a powerful N-dimensional array object\n",
"- sophisticated (broadcasting) functions\n",
"- useful linear algebra, Fourier transform, and random number capabilities\n",
"\n",
"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",
"Let's get you started with the basics! In this notebook we will cover\n",
"\n",
"1. Creating an `array`\n",
"1. Math and calculations with arrays\n",
Expand Down Expand Up @@ -1025,7 +1025,20 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.2"
"version": "3.7.15"
},
"toc": {
"base_numbering": 1,
"nav_menu": {},
"number_sections": true,
"sideBar": true,
"skip_h1_title": false,
"title_cell": "Table of Contents",
"title_sidebar": "Contents",
"toc_cell": false,
"toc_position": {},
"toc_section_display": true,
"toc_window_display": false
},
"toc-autonumbering": false
},
Expand Down
5 changes: 1 addition & 4 deletions core/overview.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Overview

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.
This page gives an overview of the Python geoscience stack.
Scroll to the end of the page for cross-referenced tutorial material for several of the packages in the stack.
We suggest that new users start with the [Foundational Skills](../foundations/overview) section in order to get the most out of these tutorials.
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.

## Core libraries

Expand Down

0 comments on commit e8ff5e2

Please sign in to comment.