Metadata-Version: 2.1
Name: registerMap
Version: 0.4.0
Summary: A Python 3 framework for creating and maintaining register maps for integrated circuit design and embedded
Home-page: https://gitlab.com/blueskyjunkie/registerMap
License: UNKNOWN
Keywords: registermap register digital electronic design
Author: Russell Smiley
Author-email: im.russell.smiley@gmail.com
Requires-Python: >=3
Description-Content-Type: text/x-rst
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Requires-Dist: jinja2
Requires-Dist: pyyaml

registerMap
-----------

|pipeline| |coverage| |documentation|

.. |pipeline| image:: https://gitlab.com/registerMap/registerMap/badges/master/pipeline.svg
   :target: https://gitlab.com/registerMap/registerMap/commits/master
   :alt: pipeline status

.. |coverage| image:: https://gitlab.com/registerMap/registerMap/badges/master/coverage.svg
   :target: https://gitlab.com/registerMap/registerMap/commits/master
   :alt: coverage report

.. |documentation| image:: https://readthedocs.org/projects/registermap/badge/?version=latest
   :target: http://registermap.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

|pypiVersion| |doi0.3.0|

.. |pypiVersion| image:: https://badge.fury.io/py/registerMap.svg
   :target: https://badge.fury.io/py/registerMap
   :alt: PyPI version

.. |doi0.3.0| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1098625.svg
   :target: https://doi.org/10.5281/zenodo.1098625
   :alt: DOI 0.3.0


A Python 3 framework for creating and maintaining register maps for integrated circuit design and embedded
software development.

.. contents::

.. section-numbering::


Main Features
=============

* define a register map by the *relationships* and *order* of modules, registers and fields
* generate address of registers and modules automatically from relationships
* constrain registers and modules by size or address
* automatically manage registers that span multiple memory units
* arbitrary number of memory unit bits (but constant across the register map)
* arbitrary number of address bits (but constant across the register map)
* automatically avoid allocating register/module addresses to page registers


Installation
============

The simplest way to acquire ``registerMap`` is using ``pip``.

.. code-block:: bash

   pip install registerMap


Documentation
=============

Head over to readthedocs_

.. _readthedocs: http://registermap.readthedocs.io/

