Skip to content

Commit

Permalink
Make README consistently markdown.
Browse files Browse the repository at this point in the history
  • Loading branch information
fperez committed Sep 20, 2015
1 parent 3157308 commit 9793d42
Showing 1 changed file with 12 additions and 22 deletions.
34 changes: 12 additions & 22 deletions README.rst → README.md
@@ -1,16 +1,11 @@
.. -*- rest -*-
.. vim:syntax=rest
========================================
Datarray: Numpy arrays with named axes
========================================
# Datarray: Numpy arrays with named axes

Scientists, engineers, mathematicians and statisticians don't just work with
matrices; they often work with structured data, just like you'd find in a
table. However, functionality for this is missing from Numpy, and there are
efforts to create something to fill the void. This is one of those efforts.

.. warning::
**Warning:**

This code is currently experimental, and its API *will* change! It is meant
to be a place for the community to understand and develop the right
Expand All @@ -26,8 +21,7 @@ Datarray provides a subclass of Numpy ndarrays that support:
- reduction operations (like .sum, .mean, etc) support named axis arguments
instead of only integer indices.

Prior Art
=========
# Prior Art

At present, there is no accepted standard solution to dealing with tabular data
such as this. However, based on the following list of ad-hoc and proposal-level
Expand Down Expand Up @@ -68,8 +62,7 @@ it. For examples, in no particular order:
ndarray to provide attributes per dimensions aiming to ease
slicing/indexing given the values of the axis attributes

Project Goals
=============
# Project Goals

1. Get something akin to this in the numpy core.

Expand All @@ -82,17 +75,14 @@ introduce confusion.
4. Oh, and make sure that the base numpy array is still accessible.


Code
====
# Code

You can find our sources and single-click downloads:

* `Main repository`_ on Github.
* Documentation_ for all releases and current development tree.
* Download as a tar/zip file the `current trunk`_.
* Downloads of all `available releases`_.

.. _main repository: http://github.com/fperez/datarray
.. _Documentation: http://fperez.github.com/datarray-doc
.. _current trunk: http://github.com/fperez/datarray/archives/master
.. _available releases: http://github.com/fperez/datarray/downloads
* [Main repository](http://github.com/fperez/datarray) on Github.
* [Documentation](http://fperez.github.com/datarray-doc) for all releases and
current development tree.
* Download as a tar/zip file the
[current trunk](http://github.com/fperez/datarray/archives/master).
* Downloads of all
[available releases](http://github.com/fperez/datarray/downloads).

0 comments on commit 9793d42

Please sign in to comment.