Skip to content

Commit

Permalink
update documentation index
Browse files Browse the repository at this point in the history
  • Loading branch information
tomcl committed Sep 18, 2024
1 parent 63bcfbf commit 40d7a64
Showing 1 changed file with 0 additions and 45 deletions.
45 changes: 0 additions & 45 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,3 @@
---
layout: home
title: "Home"

carousels:
- images:
- [image: img/homePage/keyFeatures.gif,
description: "ISSIE has an extensive library of schematic components available in the 'Catalogue' menu. Components include low-level gates, flipflops, and multiplexers, as well as larger blocks: RAMs, ROMs, configurable n-bit registers, counters and adders. Viewer components are used to (optionally) view simulation waveforms of nodes on sub-sheets. Wire label components allow any number of nodes on one design sheet to be connected without visible wires. More complex functions can quickly be constructed as sub-sheets and then used as a 'custom component' (found under 'THIS PROJECT'). Custom components can have shape and I/O positions altered at any time via an intuitive and fast drag and drop GUI",
title: "Hierarcical Design with Schematic Components"]
- [image: img/homePage/wireRouting.gif,
description: "ISSIE schematic component ports are connected using drag-and-drop: each connection represents a wire or bus. ISSIE has two methods of routing wires: <b>auto-routing</b> and <b>manual-routing</b>.
<br><br>
Wires will all start out as auto-routed, which means that the wire’s path is created automatically by the program. This path will update when moving any connected components. ISSIE also allows for manual routing, where the user may manipulate segments of the wire as desired to make the circuit more readable. Much care has been put into a user interface for routing which <i>just works</i> quickly with no learning curve.",
title: "Wire Routing"]
- [image: img/userGuide/features2.gif,
description: "The ISSIE canvas is fully customisable to allow the creation of readable and good-looking schematics. <b>Specifically:</b> <br><br> (a) Rotate, flip and Move all symbols <br> (b) Change and move around the symbols' labels <br> (c) Manually route wires as you like <br> (d) Auto-align elements <br> (e) Select the wire type you desire (radiussed, jump or modern wires)",
title: "Canvas Customization"]
- [image: img/homePage/verilogComp.PNG,
description: "ISSIE allows users to create combinational components by defining their logic in Verilog. Such component can be used as a Custom Component in all designs.
<br> <br>
For more information see the <a href=\"/issie/verilog-comp/\">Verilog Component page</a>",
title: "Verilog Component"]
- [image: img/homePage/stepSim.gif,
description: "Step Simulation allows the user to 'step' or cycle through each clock tick, and view the current design sheet's Output and Viewer component information. It also allows users to view how the state changes in stateful components such as RAM.",
title: "Step Simulation"]
- [image: img/homePage/waveSim.gif,
description: "Waveform Simulation allows the user to see the values in each selected set of connected wires (net) over time as a waveform. The waveform simulator uses a drag-and-drop GUI to delete or reorder waveforms, and a separate project explorer window to add them. Hovering on a waveform name highlights its component and all connected busses on its design sheet. Any design sheet may be viewed or edited and the simulation refreshed to see changes immediately. The values in the waveform simulator can be viewed in various formats: binary, hexadecimal, unsigned decimal and signed decimal. The Waveform Simulator uses a draggable sidebar to partition screen space dynamically between waveforms and circuit.
<br><br>
Waveform Simulation also allows for the simulation and contents viewing of memory components such as RAM.",
title: "Waveform Simulation"]
- [image: img/homePage/truthTable.png,
description: "ISSIE allows users to view the truth table for a selected circuit of combinational logic. This can be either the full truth table or a reduced one by denoting all Don't Cares with 'X's.
<br> <br>
Furthermore, users can set any number of inputs as algebra. The resultant truth table will show outputs as a function of the inputs.",
title: "Truth Table"]
- [image: img/homePage/verilogOutput.png,
description: "Users may convert their ISSIE schematic design into a Verilog file using the \"Write design as Verilog\" option found in the header bar of the application. This allows great flexibility as ISSIE designs may be used in more complex design tools and other programs that use Verilog; allowing ISSIE to be used as a top-level design that can be further developed if needed. Verilog output for simulation or synthesis is documented as part of the Verilog write process, this includes links to a <a href=\"http://bygone.clairexen.net/yosys/download.html\">YoSys</a> workflow for synthesis on FPGAs. Imperial College users can download a pre-installed VM for this workflow, the VHDL output is standalone and should work with other synthesis methods",
title: "Verilog Output"]
- [image: img/homePage/memoryEditor.png,
description: "ISSIE allows users to directly edit the contents of Memory components, for more versatility and ease of use. Memory contents can also be exported and imported via .ram files",
title: "Memory Editor"]

---

# What is ISSIE?

* ISSIE is **a very easy-to-use schematic editor and simulator** for hierarchical design of **digital logic circuits**. Run it and see the built-in demos for what it can do! ISSIE is targeted at 1st year university students, but would be useful teaching in schools and even for quick hardware design and test in an industrial or research environment. For the latter use case although we allow Verilog input and output these features need a bit more work.
Expand Down

0 comments on commit 40d7a64

Please sign in to comment.