Meno

Meno is a tool that visualizes hierarchical data, such as the sizes of directory trees or synthesized circuit sizes. It can be built into a single, standalone HTML file.

Currently, Meno supports hierarchical area reports from Vivado, Genus, and DC.

How to Use

Web Version

• Open this link and drag and drop your area report file.
• The following is a demo using the synthesis results of the RSD processor:
  • DEMO: Vivado RSD Area
  • DEMO: Design Compiler RSD Area

Use in Your Local Environment

• Download and extract the pre-built files from this link.
• Drag and drop an input file onto index.html to visualize it.
• You can create an HTML file with your input file embedded by passing the input file to embed.sh:

  # Generate an HTML file (your_area_report.txt.html) in the same directory.
  ./embed.sh your_area_report.txt
  
  # Launch an WEB server, which is useful to view the output HTML from a remote client. 
  ./launch_httpd.sh

Development

This project is designed for development using Node.js (version 18) on Ubuntu 24.04. If you encounter compatibility issues, it is recommended to use the following Docker environment, which is based on an Ubuntu 24.04 image.

# Initialize Node modules
make init

# Build the project
# If the build completes successfully, dist/index.html will be generated.
make production

# Build debug version
make

# Launch the development server
make serve

# Build a Docker environment
make docker-build

# Enter the Docker environment
make docker-run

# Alternatively, after setting up the Docker environment, you can launch 'make' or other commands directly.
./docker/run.sh make

License

Copyright (C) 2016-2024 Ryota Shioya [email protected]

This application is released under the 3-Clause BSD License, see LICENSE.md. This application bundles third-party packages in accordance with the licenses presented in THIRD-PARTY-LICENSES.md.