Skip to content

Commit

Permalink
Add README.
Browse files Browse the repository at this point in the history
  • Loading branch information
skrah committed Apr 27, 2024
1 parent 5b224f9 commit 482598b
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions ndtypes/README.rst
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 482598b

Please sign in to comment.