summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRahul P2019-11-22 16:23:44 +0530
committerGitHub2019-11-22 16:23:44 +0530
commit33a25476fe72d3954b8d4321d04143c3611a06b7 (patch)
tree8f5244eca102ad6bc4cf86881aa7b78d4a6bd120 /readme.md
parenta6c0b36fcaba6c1f2d366432b2386122674b4782 (diff)
parent04d535a74420cfd6b757f9298ac6f5d4d3d30732 (diff)
downloadnghdl-33a25476fe72d3954b8d4321d04143c3611a06b7.tar.gz
nghdl-33a25476fe72d3954b8d4321d04143c3611a06b7.tar.bz2
nghdl-33a25476fe72d3954b8d4321d04143c3611a06b7.zip
Merge pull request #30 from rahulp13/master
removed model stop-time
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md27
1 files changed, 12 insertions, 15 deletions
diff --git a/readme.md b/readme.md
index f2e9a02..b8d3754 100644
--- a/readme.md
+++ b/readme.md
@@ -3,8 +3,8 @@ Ngspice Ghdl Interfacing Documentation
It contains all the documenation for Ngspice and Ghdl related work.
-Note: This project is still in alpha version and has been tested for basic digital components.
-====
+> Note: This project is in beta version and has been tested for rings, counters and PWM controllers.
+
## What exactly interfacing of ngspice ghdl do?
Ngspice support mixed mode simulation. It can simulate both digital and analog component.
@@ -18,7 +18,7 @@ for that model it will actually call the ghdl to get the result.
##Pre-requisites
-1. Ubuntu 12.04 (You can try it on other version and let us know)
+1. Ubuntu 12.04-16.04 (You can try it on other version and let us know)
2. Python 2.7
3. PyQt4
@@ -26,26 +26,23 @@ for that model it will actually call the ghdl to get the result.
##How to install?
1. Clone this repository.
2. Run `./install-nghdl.sh` It will install ngspice from source code and put it in $HOME.
-3. Set ngspice path in `.bashrc` file. Add `export PATH=/home/{your-username}/ngspice-26/install_dir/bin:$PATH` line in .bashrc
+3. Set ngspice path in `.bashrc` file. Add `export PATH=/home/{your-username}/ngspice-nghdl/install_dir/bin:$PATH` line in .bashrc
+
##Few words about installed code structure.
-1. Ngspice will be installed in home directory $HOME. If you already have ngspice-26 directory there it will take its backup.
+1. Ngspice will be installed in home directory $HOME. If you already have ngspice-31 directory there it will take its backup.
2. Source code for all other file will be present in ~/.esim-nghdl
3. symlink nghdl is stored in /usr/local/bin
+
##How to use?
1. Run nghdl in command terminal.
2. Upload your vhdl file.
-3. Model will be created with name of your vhdl file. It can be seen under (~ngspice-26/src/xspice/icm/ghdl/)
+3. Model will be created with name of your vhdl file. It can be seen under (~/ngspice-nghdl/src/xspice/icm/ghdl/)
4. You can use this model in your netlist.
-##LIMITATION:
-1. You can use only one output port in your file.
-2. All the port should be std_logic_vector only.
-3. We can use only one instance of code model in netlist.
-
-##FUTURE WORK
-1. Make changes to have more than one output.
-2. Making changes to include use of more than one instance of code models.
-3. Interfacing it with eSim formely known as Oscad so that we can use it in our schematic.
+##FEATURES:
+1. Support for 512 digital models.
+2. Support for digital models upto 64 output ports/pins.
+3. Multiple instances of same digital model.