From 9225e3a97a9d703d56f1f9f18067c05ed66e373a Mon Sep 17 00:00:00 2001 From: iulia Date: Tue, 29 Aug 2017 14:27:30 +0300 Subject: [PATCH 1/4] Update Overview page in documentation --- doc/source/overview.rst | 85 +++++++++++++++++++++++++---------------- 1 file changed, 53 insertions(+), 32 deletions(-) diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 92caeec319169..b35aed085720e 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -2,11 +2,14 @@ .. currentmodule:: pandas -**************** Package overview **************** -:mod:`pandas` consists of the following things +:mod:`pandas` is an open source, BSD-licensed library providing high-performance, +easy-to-use data structures and data analysis tools for the `Python `__ +programming language. + +:mod:`pandas` consists of the following elements * A set of labeled array data structures, the primary of which are Series and DataFrame @@ -24,20 +27,19 @@ Package overview * Static and moving window linear and `panel regression `__ -Data structures at a glance ---------------------------- +Data Structures +--------------- .. csv-table:: :header: "Dimensions", "Name", "Description" :widths: 15, 20, 50 - 1, Series, "1D labeled homogeneously-typed array" - 2, DataFrame, "General 2D labeled, size-mutable tabular structure with - potentially heterogeneously-typed columns" - 3, Panel, "General 3D labeled, also size-mutable array" + 1, "Series", "1D labeled homogeneously-typed array" + 2, "DataFrame", "General 2D labeled, size-mutable tabular structure with potentially heterogeneously-typed column" + 3, "Panel", "General 3Dlabeled, also size-mutable array" -Why more than 1 data structure? -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Why more than one data structure? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The best way to think about the pandas data structures is as flexible containers for lower dimensional data. For example, DataFrame is a container @@ -85,36 +87,55 @@ The first stop for pandas issues and ideas is the `Github Issue Tracker pandas community experts can answer through `Stack Overflow `__. -Longer discussions occur on the `developer mailing list -`__, and commercial support -inquiries for Lambda Foundry should be sent to: support@lambdafoundry.com +Community +--------- -Credits -------- +pandas is actively supported today by a community of like-minded individuals around +the world who contribute their valuable time and energy to help make open source +pandas possible. Thanks to `all of our contributors `__. + +If you're interested in contributing, please +visit `Contributing to pandas webpage `__. + +pandas is a `NUMFocus `__ sponsored project. +This will help ensure the success of development of pandas as a world-class open-source +project, and makes it possible to `donate `__ to the project. -pandas development began at `AQR Capital Management `__ in -April 2008. It was open-sourced at the end of 2009. AQR continued to provide -resources for development through the end of 2011, and continues to contribute -bug reports today. +Project Governance +------------------ -Since January 2012, `Lambda Foundry `__, has -been providing development resources, as well as commercial support, -training, and consulting for pandas. +The governance process that pandas project has used informally since its inception in 2008 is formalized in `Project Governance documents `__ . +The documents clarify how decisions are made and how the various elements of our community interact, including the relationship between open source collaborative development and work that may be funded by for-profit or non-profit entities. -pandas is only made possible by a group of people around the world like you -who have contributed new code, bug reports, fixes, comments and ideas. A -complete list can be found `on Github `__. +Wes McKinney is the Benevolent Dictator for Life (BDFL). -Development Team ----------------- +Current Core Team +----------------- -pandas is a part of the PyData project. The PyData Development Team is a -collection of developers focused on the improvement of Python's data -libraries. The core team that coordinates development can be found on `Github -`__. If you're interested in contributing, please -visit the `project website `__. +* Tom Augspurger +* Chris Bartak +* Phillip Cloud +* Andy Hayden +* Stephan Hoyer +* Wes McKinney +* Jeff Reback +* Chang She +* Masaaki Horikoshi +* Joris Van den Bossche + +More details and the past Core Team members can be found on the `people’s page `__ of the governance repo. + + +Institutional Partners +---------------------- + +Institutional Partners are companies and universities that support the project by employing contributors. Current Institutional Partners include: + +* `Continuum Analytics `__ +* `Two Sigma `__ License ------- .. literalinclude:: ../../LICENSE + From d1f766829a609bd7da13e96756f9bbaba36a698d Mon Sep 17 00:00:00 2001 From: iulia Date: Tue, 29 Aug 2017 22:24:28 +0300 Subject: [PATCH 2/4] DOC Revise Overview page --- doc/source/overview.rst | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/doc/source/overview.rst b/doc/source/overview.rst index b35aed085720e..dd7fba2d48857 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -2,6 +2,7 @@ .. currentmodule:: pandas +**************** Package overview **************** @@ -109,21 +110,10 @@ The documents clarify how decisions are made and how the various elements of our Wes McKinney is the Benevolent Dictator for Life (BDFL). -Current Core Team +Development Team ----------------- -* Tom Augspurger -* Chris Bartak -* Phillip Cloud -* Andy Hayden -* Stephan Hoyer -* Wes McKinney -* Jeff Reback -* Chang She -* Masaaki Horikoshi -* Joris Van den Bossche - -More details and the past Core Team members can be found on the `people’s page `__ of the governance repo. +The list of the Core Team members and more detailed information can be found on the `people’s page `__ of the governance repo. Institutional Partners From f94a09db465c90400a82a5dcf77f6c78b2b2d311 Mon Sep 17 00:00:00 2001 From: iulia Date: Wed, 30 Aug 2017 16:56:18 +0300 Subject: [PATCH 3/4] DOC Make further revisions in Overview webpage --- doc/source/overview.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/doc/source/overview.rst b/doc/source/overview.rst index dd7fba2d48857..82afc8ac99b82 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -37,7 +37,7 @@ Data Structures 1, "Series", "1D labeled homogeneously-typed array" 2, "DataFrame", "General 2D labeled, size-mutable tabular structure with potentially heterogeneously-typed column" - 3, "Panel", "General 3Dlabeled, also size-mutable array" + 3, "Panel", "General 3D labeled, also size-mutable array" Why more than one data structure? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -119,10 +119,7 @@ The list of the Core Team members and more detailed information can be found on Institutional Partners ---------------------- -Institutional Partners are companies and universities that support the project by employing contributors. Current Institutional Partners include: - -* `Continuum Analytics `__ -* `Two Sigma `__ +The information about current institutional partners can be found on `pandas website page `__ License ------- From d8601eb006c296335978a95823bf9a45c8fc8b35 Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Wed, 30 Aug 2017 11:39:28 -0500 Subject: [PATCH 4/4] Update overview.rst Remove references to Panel --- doc/source/overview.rst | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 82afc8ac99b82..00a71603e1261 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -25,8 +25,6 @@ programming language. * Memory-efficient "sparse" versions of the standard data structures for storing data that is mostly missing or mostly constant (some fixed value) * Moving window statistics (rolling mean, rolling standard deviation, etc.) - * Static and moving window linear and `panel regression - `__ Data Structures --------------- @@ -37,14 +35,13 @@ Data Structures 1, "Series", "1D labeled homogeneously-typed array" 2, "DataFrame", "General 2D labeled, size-mutable tabular structure with potentially heterogeneously-typed column" - 3, "Panel", "General 3D labeled, also size-mutable array" Why more than one data structure? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The best way to think about the pandas data structures is as flexible containers for lower dimensional data. For example, DataFrame is a container -for Series, and Panel is a container for DataFrame objects. We would like to be +for Series, and Series is a container for scalars. We would like to be able to insert and remove objects from these containers in a dictionary-like fashion.