Add some basic aliases, and some basic documentation

Author: asmeurer

numpy_array_api_compat/__init__.py

@@ -1 +1,24 @@
+"""
+NumPy Array API compatibility library
+
+This is a small wrapper around NumPy that is compatible with the Array API
+standard https://data-apis.org/array-api/latest/. See also NEP 47
+https://numpy.org/neps/nep-0047-array-api-standard.html.
+
+Unlike numpy.array_api, this is not a strict minimal implementation of the
+Array API, but rather just an extension of the main NumPy namespace with
+changes needed to be compliant with the Array API. See
+https://numpy.org/doc/stable/reference/array_api.html for a full list of
+changes. In particular, unlike numpy.array_api, this package does not use a
+separate Array object, but rather just uses numpy.ndarray directly.
+
+Library authors using the Array API may wish to test against numpy.array_api
+to ensure they are not using functionality outside of the standard, but prefer
+this implementation for the default when working with NumPy arrays.
+
+"""
+
 from numpy import *
+
+# These imports may overwrite names from the import * above.
+from ._aliases import *

numpy_array_api_compat/_aliases.py

@@ -0,0 +1,20 @@
+"""
+These are functions that are just aliases of existing functions in NumPy.
+"""
+
+from numpy import (arccos, arccosh, arcsin, arcsinh, arctan, arctan2, arctanh,
+                   left_shift, invert, right_shift, bool_, concatenate, power)
+
+acos = arccos
+acosh = arccosh
+asin = arcsin
+asinh = arcsinh
+atan = arctan
+atan2 = arctan2
+atanh = arctanh
+bitwise_left_shift = left_shift
+bitwise_invert = invert
+bitwise_right_shift = right_shift
+bool = bool_
+concat = concatenate
+pow = power