Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update Overview page in documentation #17368

Merged
merged 4 commits into from
Aug 30, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 38 additions & 33 deletions doc/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
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 <https://www.python.org/>`__
programming language.

:mod:`pandas` consists of the following elements

* A set of labeled array data structures, the primary of which are
Series and DataFrame
Expand All @@ -21,27 +25,23 @@ Package overview
* 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
<http://en.wikipedia.org/wiki/Panel_data>`__

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"

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
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.

Expand Down Expand Up @@ -85,36 +85,41 @@ The first stop for pandas issues and ideas is the `Github Issue Tracker
pandas community experts can answer through `Stack Overflow
<http://stackoverflow.com/questions/tagged/pandas>`__.

Longer discussions occur on the `developer mailing list
<http://groups.google.com/group/pystatsmodels>`__, and commercial support
inquiries for Lambda Foundry should be sent to: [email protected]
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 <https://github.com/pandas-dev/pandas/graphs/contributors>`__.

If you're interested in contributing, please
visit `Contributing to pandas webpage <http://pandas.pydata.org/pandas-docs/stable/contributing.html>`__.

pandas development began at `AQR Capital Management <http://www.aqr.com>`__ 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.
pandas is a `NUMFocus <https://www.numfocus.org/open-source-projects/>`__ 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 <https://pandas.pydata.org/donate.html>`__ to the project.

Since January 2012, `Lambda Foundry <http://www.lambdafoundry.com>`__, has
been providing development resources, as well as commercial support,
training, and consulting for pandas.
Project Governance
------------------

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 <http://www.github.com/pandas-dev/pandas/contributors>`__.
The governance process that pandas project has used informally since its inception in 2008 is formalized in `Project Governance documents <https://github.com/pandas-dev/pandas-governance>`__ .
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.

Wes McKinney is the Benevolent Dictator for Life (BDFL).

Development Team
----------------
-----------------

The list of the Core Team members and more detailed information can be found on the `people’s page <https://github.com/pandas-dev/pandas-governance/blob/master/people.md>`__ of the governance repo.


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
<http://github.com/pydata>`__. If you're interested in contributing, please
visit the `project website <http://pandas.pydata.org>`__.
Institutional Partners
----------------------

The information about current institutional partners can be found on `pandas website page <https://pandas.pydata.org/about.html>`__

License
-------

.. literalinclude:: ../../LICENSE