Metadata-Version: 2.1
Name: hierplace
Version: 0.3.1
Summary: Groups and arranges KiCAD PCBNEW board parts so they reflect the design hierarchy.
Home-page: https://github.com/xesscorp/kinet2pcb
Author: XESS Corp.
Author-email: info@xess.com
License: MIT license
Description: # XESS 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.
        
        ![](initial_placement.png)
        
        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.
        
        ![](hierarchical_placement.png)
        
        
        ## Credits
        
        ### Development Lead
        
        * XESS Corp. <info@xess.com>
        
        ### Contributors
        
        None yet. Why not be the first?
        
        
        # History
        
        
        ## 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.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
