hierplace


Namehierplace JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/devbisme/HierPlace
SummaryGroups and arranges KiCAD PCBNEW board parts so they reflect the design hierarchy.
upload_time2023-08-10 16:06:59
maintainer
docs_urlNone
authorDave Vandenbout
requires_python
licenseMIT license
keywords hierplace kicad eda pcbnew
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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.1.0 (2023-08-10)
------------------

* Updated to be compatible with KiCad 7.


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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/devbisme/HierPlace",
    "name": "hierplace",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "HierPlace KiCad EDA PCBNEW",
    "author": "Dave Vandenbout",
    "author_email": "devb@xess.com",
    "download_url": "https://files.pythonhosted.org/packages/19/01/1d98cd0e18ab5485850f1b30c28ad4e8a768dfe43a2852c2efaf6c369775/hierplace-1.1.0.tar.gz",
    "platform": null,
    "description": "Hierarchical Placement Plugin\n==================================\n\nThis PCBNEW plugin arranges the parts into groups that reflect the\nhierarchy in the design.\n\n-  Free software: MIT license\n\nFeatures\n--------\n\n-  Creates an arrangement of the parts that reflects their level in the\n   design hierarchy.\n-  Will arrange only the parts that have been selected or, if no parts\n   are selected, the entire design.\n-  Will not move locked parts.\n\nInstallation\n------------\n\nOn linux, just copy ``HierPlace.py`` to your local ``~/.kicad_plugins``\ndirectory.\n\nUsage\n-----\n\nThere are two ways to use this plugin:\n\n1. Press the ``Tools => External Plugins... => HierPlace`` button and\n   all the unlocked parts will be arranged.\n\n2. Select a subset of the parts and press the ``HierPlace`` button and\n   only the unlocked parts in the selection will be arranged.\n\nExample\n~~~~~~~\n\nHere is an example of an initial arrangement of parts in PCBNEW. The\nSDRAM BGA and its seven decoupling capacitors are highlighted to show\nhow widely separated they are. Other sections of the circuitry are\nsimilarly scattered.\n\n|image0|\n\nThe arrangement after running ``HierPlace`` is shown below. Now the\nSDRAM and its decoupling capacitors are closely grouped, as are the\nother sections of the circuitry.\n\n|image1|\n\nCredits\n-------\n\nDevelopment Lead\n~~~~~~~~~~~~~~~~\n\n* Dave Vandenbout <devb@xess.com>\n\n`Other Contributors <https://github.com/devbisme/HierPlace/graphs/contributors>`_\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n\nNone yet. Why not be the first?\n\n.. |image0| image:: initial_placement.png\n.. |image1| image:: hierarchical_placement.png\n\n\nHistory\n=======\n\n1.1.0 (2023-08-10)\n------------------\n\n* Updated to be compatible with KiCad 7.\n\n\n1.0.0 (2021-09-16)\n------------------\n\n* Decided this tool was mature to the point it could be called 1.0.0.\n\n\n0.3.2 (2021-05-24)\n------------------\n\n-  Still trying to get setup to work correctly.\n\n\n0.3.1 (2021-05-21)\n------------------\n\n-  Trying to get setup to work correctly.\n\n\n0.3.0 (2021-05-19)\n------------------\n\n-  ``hierplace()`` function is now usable in other packages like\n   ``kinet2pcb``.\n\n\n0.2.0 (2021-04-27)\n------------------\n\n-  Now supports both KiCad 5 and 5.99.\n\n\n0.1.0 (2018-05-27)\n------------------\n\n-  First release.\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "Groups and arranges KiCAD PCBNEW board parts so they reflect the design hierarchy.",
    "version": "1.1.0",
    "project_urls": {
        "Changelog": "https://github.com/devbisme/HierPlace/blob/master/HISTORY.rst",
        "Documentation": "https://github.com/devbisme/HierPlace/blob/master/README.rst",
        "Homepage": "https://github.com/devbisme/HierPlace",
        "Source": "https://github.com/devbisme/HierPlace",
        "Tracker": "https://github.com/devbisme/HierPlace/issues"
    },
    "split_keywords": [
        "hierplace",
        "kicad",
        "eda",
        "pcbnew"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "19011d98cd0e18ab5485850f1b30c28ad4e8a768dfe43a2852c2efaf6c369775",
                "md5": "117d2071082d68b620c94b37b575b5bb",
                "sha256": "1386717bb9e6759d9b319013d6edd0f568b717f834e29d9d804ab5cc4c0d0ad0"
            },
            "downloads": -1,
            "filename": "hierplace-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "117d2071082d68b620c94b37b575b5bb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 313737,
            "upload_time": "2023-08-10T16:06:59",
            "upload_time_iso_8601": "2023-08-10T16:06:59.887468Z",
            "url": "https://files.pythonhosted.org/packages/19/01/1d98cd0e18ab5485850f1b30c28ad4e8a768dfe43a2852c2efaf6c369775/hierplace-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-10 16:06:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "devbisme",
    "github_project": "HierPlace",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "hierplace"
}
        
Elapsed time: 2.06177s