Skip to content

Commit

Permalink
Docs Update 2 (#698)
Browse files Browse the repository at this point in the history
* logo link must be raw for PyPI

* add plugin selection guide, update copyright

* add publications to front page
  • Loading branch information
harrisonliew authored Jan 24, 2023
1 parent 9a76066 commit 63147a9
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Logo design by @kenhoberkeley](doc/logo_transparent.png)
![Logo design by @kenhoberkeley](https://github.com/ucb-bar/hammer/raw/master/doc/logo_transparent.png)

![Hammer PR CI](https://github.com/ucb-bar/hammer/actions/workflows/pr.yml/badge.svg?event=push) ![Hammer publish CI](https://github.com/ucb-bar/hammer/actions/workflows/publish.yml/badge.svg)

Expand Down Expand Up @@ -28,4 +28,9 @@ History
=======
The list of contributors can be found in the Git history of the project, or online at https://github.com/ucb-bar/hammer/graphs/contributors

The Hammer project builds upon the legacy of the [PLSI project by Palmer Dabbelt](https://www2.eecs.berkeley.edu/Pubs/TechRpts/2017/EECS-2017-77.html), a previous project which aimed to build a portable VLSI flow. The Hammer project is grateful for the feedback and lessons learned which provided valuable insight that ultimately led to the design and software architecture of Hammer as it is now.
The Hammer project builds upon the legacy of the PLSI project by Palmer Dabbelt, a previous project which aimed to build a portable VLSI flow. The Hammer project is grateful for the feedback and lessons learned which provided valuable insight that ultimately led to the design and software architecture of Hammer as it is now.

Below is the list of Hammer publications in reverse chronological order:
- [Hammer: a modular and reusable physical design flow tool (DAC 2022)](https://dl.acm.org/doi/abs/10.1145/3489517.3530672)
- [A Methodology for Reusable Physical Design (ISQED 2020)](https://ieeexplore.ieee.org/document/9136999)
- [PLSI: A Portable VLSI Flow (Master's Thesis, 2017)](https://www2.eecs.berkeley.edu/Pubs/TechRpts/2017/EECS-2017-77.html)
26 changes: 26 additions & 0 deletions doc/Hammer-Basics/Migration-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,30 @@ This guide is relevant for both plugin developers and general users.

[The documentation for old Hammer is cached here](https://hammer-vlsi.readthedocs.io/en/0.1.0/).

## Selecting Plugins

Previously, tech and tool plugins were selected with a combination of tool name and relative plugin path:

```yaml
vlsi.core.technology: <tech_name>
vlsi.core.technology_path: ["hammer-<tech_name>-plugin"]
vlsi.core.technology_path_meta: append

vlsi.core.synthesis_tool: <syn_tool_name>
vlsi.core.synthesis_tool_path: ["hammer-<vendor>-plugin/syn"]
vlsi.core.synthesis_tool_meta: append
```
Now, you simply need to specify the package name:
```yaml
vlsi.core.technology: hammer.technology.<tech_name>

vlsi.core.synthesis_tool: hammer.synthesis.<syn_tool_name>
```
See the [](plugin_package) section below for details about plugin package structure.
## `import` Statements

When importing Hammer classes and/or methods, replace old statements:
Expand Down Expand Up @@ -77,6 +101,8 @@ is now:
]
```

(plugin_package)=

## Plugin File Structure

Plugins previously did not have a file structure requirement. For example, it could have looked like this:
Expand Down
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'Hammer'
copyright = '2019, Berkeley Architecture Research'
copyright = '2023, Berkeley Architecture Research'
author = 'Berkeley Architecture Research'

# The full version, including alpha/beta/rc tags
Expand Down

0 comments on commit 63147a9

Please sign in to comment.