From 482598b11e76d01caa683450369eba93bc7a0ae8 Mon Sep 17 00:00:00 2001 From: Stefan Krah Date: Sat, 27 Apr 2024 19:20:28 +0200 Subject: [PATCH] Add README. --- ndtypes/README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/ndtypes/README.rst b/ndtypes/README.rst index e69de29..f2c1505 100644 --- a/ndtypes/README.rst +++ b/ndtypes/README.rst @@ -0,0 +1,21 @@ +Overview +-------- + +The ``ndtypes`` module is the Python interface to the ``libndtypes`` library. +``libndtypes`` implements dynamic types relevant for scientific computing. + +These types contain full memory layout information and are used both for type +checking and accessing values in memory. + +Types are specified using a close variant of the datashape language. + +``ndtypes`` supports other container modules. It displays types, performs +type checking, and the concrete type layout information is used to traverse +memory. + +As an example, ``xnd`` is a container module that is based on ``ndtypes``. + +Links +----- + +* https://github.com/xnd-project/