Metadata-Version: 2.1
Name: hierplace
Version: 1.0.0
Summary: Groups and arranges KiCAD PCBNEW board parts so they reflect the design hierarchy.
Home-page: https://github.com/devbisme/HierPlace
Author: Dave Vandenbout
Author-email: devb@xess.com
License: MIT license
Project-URL: Documentation, https://github.com/devbisme/HierPlace/blob/master/README.rst
Project-URL: Source, https://github.com/devbisme/HierPlace
Project-URL: Changelog, https://github.com/devbisme/HierPlace/blob/master/HISTORY.rst
Project-URL: Tracker, https://github.com/devbisme/HierPlace/issues
Keywords: HierPlace KiCad EDA PCBNEW
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Manufacturing
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Description-Content-Type: text/x-rst
License-File: LICENSE

Hierarchical Placement Plugin
==================================

This PCBNEW plugin arranges the parts into groups that reflect the
hierarchy in the design.

-  Free software: MIT license

Features
--------

-  Creates an arrangement of the parts that reflects their level in the
   design hierarchy.
-  Will arrange only the parts that have been selected or, if no parts
   are selected, the entire design.
-  Will not move locked parts.

Installation
------------

On linux, just copy ``HierPlace.py`` to your local ``~/.kicad_plugins``
directory.

Usage
-----

There are two ways to use this plugin:

1. Press the ``Tools => External Plugins... => HierPlace`` button and
   all the unlocked parts will be arranged.

2. Select a subset of the parts and press the ``HierPlace`` button and
   only the unlocked parts in the selection will be arranged.

Example
~~~~~~~

Here is an example of an initial arrangement of parts in PCBNEW. The
SDRAM BGA and its seven decoupling capacitors are highlighted to show
how widely separated they are. Other sections of the circuitry are
similarly scattered.

|image0|

The arrangement after running ``HierPlace`` is shown below. Now the
SDRAM and its decoupling capacitors are closely grouped, as are the
other sections of the circuitry.

|image1|

Credits
-------

Development Lead
~~~~~~~~~~~~~~~~

* Dave Vandenbout <devb@xess.com>

`Other Contributors <https://github.com/devbisme/HierPlace/graphs/contributors>`_
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


None yet. Why not be the first?

.. |image0| image:: initial_placement.png
.. |image1| image:: hierarchical_placement.png


History
=======

1.0.0 (2021-09-16)
------------------

* Decided this tool was mature to the point it could be called 1.0.0.


0.3.2 (2021-05-24)
------------------

-  Still trying to get setup to work correctly.


0.3.1 (2021-05-21)
------------------

-  Trying to get setup to work correctly.


0.3.0 (2021-05-19)
------------------

-  ``hierplace()`` function is now usable in other packages like
   ``kinet2pcb``.


0.2.0 (2021-04-27)
------------------

-  Now supports both KiCad 5 and 5.99.


0.1.0 (2018-05-27)
------------------

-  First release.


