[GSoC] Common Python Simulation module #226

harshkhandeparkar · 2023-08-09T20:31:51Z

Related to #211

Changes

Added a common Python simulation module for use across all generators.
Used the simulation module to simplify and improve the Temperature Sensor generator simulations.
Added documentation (both in Python and in docs/ that is hosted on ReadTheDocs) for the module.
Regression Tests

Features of the Simulation Module

Easy to sweep through multiple parameters.
Generates the output in a well-defined directory structure.
Supports Mako templating syntax for inserting parameters in SPICE templates (just like in Verilog templates).
Runs concurrent simulations.
Reports the simulation status.

Simulations for the DC-DC generator will be based on this.

Screenshots

saicharan0112

I see a lot of changes. Let me review it one by one.

harshkhandeparkar · 2023-08-23T17:07:55Z

@saicharan0112 any update on this?

saicharan0112

LGTM

msaligane · 2023-09-07T15:48:41Z

.github/workflows/test_code.yml

can this file be renamed in a better way?

Renaming files might break other flows. @saicharan0112, could you please confirm if it is ok to rename this?

Yes that shouldn't be a problem

msaligane · 2023-09-07T15:49:20Z

docs/source/common-python-api.rst

We should probably rename this as well.

openfasoc/generators/common/simulation/simulation_run.py

msaligane · 2023-09-07T15:52:53Z

openfasoc/generators/temp-sense-gen/simulations/templates/tempsenseInst_xyce.sp

Are we using Xyce?

There is a option to use it (a CLI argument) but I am not sure if it is actually used anywhere or if it is working.

We are installing Xyce as part of the installation script. I remember having problems with the simulations using Xyce but I don't know if there is any progress on that side in general inside OpenFASoC

openfasoc/generators/temp-sense-gen/tools/readparamgen.py

msaligane · 2023-09-07T15:55:35Z

tests/common_api/test-simulation/expected/3/sim_3.sp

These are regression tests for the common-api? the naming is kind of weird.

These are the expected SPICE files generated from template.sp. There are 8 possible combinations of parameters, and hence 8 different configurations are generated.

The regression test checks if the correct configurations are generated by comparing the file generated during the testing to the expected file.

@msaligane I don't think these are actually problems.

openfasoc/generators/temp-sense-gen/test.json

saicharan0112

@harshkhandeparkar I think the refactoring the simulation part of the generators can be made compatible with the CI. My only concern is the independence of the functions that were previously in separate files such as result.py and result_error.py. Are these refactored functions standalone and can be initialized directly in a different python file or does it expect any declarations that are only known inside the newly developed simulation.py ?

harshkhandeparkar · 2023-09-10T06:25:11Z

@harshkhandeparkar I think the refactoring the simulation part of the generators can be made compatible with the CI. My only concern is the independence of the functions that were previously in separate files such as result.py and result_error.py. Are these refactored functions standalone and can be initialized directly in a different python file or does it expect any declarations that are only known inside the newly developed simulation.py ?

As far as I remember, the functionality is intact and modular. The functions were moved (and might be renamed) to simulation_error.py, which is now a Python module that can be imported but doesn't run anything. Could you tell which functions from the previous files were required? If they are not available anymore, I'll add them back.

msaligane · 2023-09-11T15:24:36Z

@harshkhandeparkar can you pull the changes from the main repo.

docs: updated parameters documentation docs: added docs for the top level simulation function docs: fixed errors in simulation module docs

* refactored result.py and result_error.py into simulation_result.py * exported functions to calculate the simulation results instead of directly calculating * calculate and write the values to the result files in simulation.py * refactored and cleaned temp-sense-gen.py simulation code * made independent of simulation_result.py temperature range * removed any hardcoded values

harshkhandeparkar · 2023-09-11T15:36:44Z

@harshkhandeparkar can you pull the changes from the main repo.

Done.

saicharan0112 · 2023-10-01T11:50:48Z

@harshkhandeparkar looks like the simulation module changes are not working from the beginning? (another fault of CI is detected thanks to this). not sure how the python tests didn't see this as well. Can you try running the temp-sense-gen again at your side please? Just run make temp-sense-gen and you should be able to see the error while importing the calculate_error... function from simulation_result.py inside the main temp-sense-gen.py file

harshkhandeparkar · 2023-10-01T12:21:03Z

@harshkhandeparkar looks like the simulation module changes are not working from the beginning? (another fault of CI is detected thanks to this). not sure how the python tests didn't see this as well. Can you try running the temp-sense-gen again at your side please? Just run make temp-sense-gen and you should be able to see the error while importing the calculate_error... function from simulation_result.py inside the main temp-sense-gen.py file

I just tested it and it works on my system locally but it does not work in the openfasoc Docker container. I believe this is because the container uses Python version 3.7.x. Is it possible to bump the version?

Also I think I made a big mistake in #233 which caused the CI to not run at all.

saicharan0112 · 2023-10-01T18:33:13Z

@harshkhandeparkar looks like the simulation module changes are not working from the beginning? (another fault of CI is detected thanks to this). not sure how the python tests didn't see this as well. Can you try running the temp-sense-gen again at your side please? Just run make temp-sense-gen and you should be able to see the error while importing the calculate_error... function from simulation_result.py inside the main temp-sense-gen.py file

I just tested it and it works on my system locally but it does not work in the openfasoc Docker container. I believe this is because the container uses Python version 3.7.x. Is it possible to bump the version?

Also I think I made a big mistake in #233 which caused the CI to not run at all.

Yes but I handled it in #240 . Regarding the python version, I am not sure. The entire environment is kind of pinned to 3.7. I think there is a way to use 3.8 (something that I am looking into #237) but 3.10 is something I am not sure about.

saicharan0112 · 2023-10-01T19:38:29Z

I think I am able to find a way to install all tools in python 3.10. I still need to test the generators with latest openroad (not sure how big that will blow) but I will update the docker image to give you the python version that you need for your code.

harshkhandeparkar · 2023-10-02T07:18:55Z

I think I am able to find a way to install all tools in python 3.10. I still need to test the generators with latest openroad (not sure how big that will blow) but I will update the docker image to give you the python version that you need for your code.

I can try to make it compatible with 3.7.

saicharan0112 · 2023-10-02T10:31:33Z

I think I am able to find a way to install all tools in python 3.10. I still need to test the generators with latest openroad (not sure how big that will blow) but I will update the docker image to give you the python version that you need for your code.

I can try to make it compatible with 3.7.

no 3.7 is quite old and miniconda not supporting 3.7 is a sign for developers not use it anymore. Also since now all dependencies are working in 3.10 env, there should be no problem in handling such stuff.

harshkhandeparkar mentioned this pull request Aug 9, 2023

[GSoC] Common Python API #211

Open

11 tasks

harshkhandeparkar marked this pull request as draft August 10, 2023 05:49

harshkhandeparkar marked this pull request as ready for review August 14, 2023 14:07

msaligane requested a review from saicharan0112 August 17, 2023 17:25

saicharan0112 reviewed Aug 18, 2023

View reviewed changes

This was referenced Aug 23, 2023

[GSoC] Updated LDO Simulations #229

Merged

[GSoC] Updated DC-DC Verilog Generation and Simulations #230

Open

saicharan0112 approved these changes Aug 23, 2023

View reviewed changes

msaligane requested changes Sep 7, 2023

View reviewed changes

saicharan0112 reviewed Sep 9, 2023

View reviewed changes

openfasoc/generators/temp-sense-gen/test.json Outdated Show resolved Hide resolved

saicharan0112 reviewed Sep 9, 2023

View reviewed changes

harshkhandeparkar added 16 commits September 11, 2023 21:04

feat: added a simulation module

321806a

fix: fixed multiple bugs in simulation.py

5377c45

feat: multithreaded improvements for simulation module

b7fae70

fix: many bug fixes

e0feb35

refactor: split simulation module into multiple files

f53736a

feat: allow different types of parameters in simulation

0d8571f

feat: added numeric parameter (start, end, step)

3d82f29

docs: added docs for the simulation module

b1bdc1b

docs: added docs for simulation_run.py

1667902

docs: updated parameters documentation docs: added docs for the top level simulation function docs: fixed errors in simulation module docs

feat: added support for xyce and finesim

c653620

feat: remove existing run directories

54e8fcd

feat: read simulation temp range from test.json

e5c86c5

fix: used rmtree instead of rmdir

5df02d9

feat: used the new simulation module in temp-sense-gen

4592e19

refactor: simplified temp-sense-gen python code

52a956e

refactor: simplified simulation.py

24a4c2e

harshkhandeparkar added 18 commits September 11, 2023 21:04

feat: gitignored simulations

e22a087

feat: return the number of simulations run

61e4336

fix: removed whitespace from sim log files

62257ab

feat: changed temperature range back to original

3b1ffed

feat: print the average time per simulation

1aae288

fix: fixed errors in simulation_result.py

adf0d88

docs: updated docstring for top level common module

f9367ff

fix: fixed types in temp sensor simulations

233e255

docs: fixed typo in simulation module

758ed4b

docs: fixed the default sim tool typo

4894285

docs: added sphinx documentation for the simulation module

70af3be

test: added regression tests for the simulation module.

661591b

fix: replaced match case with if else statements

5d82ae4

fix: keep track of failed simulations

e5e61d7

fix: install ngspice for python unit tests

eb17120

fix: capture simulation output so it doesn't show in the terminal

e47d8db

docs: added top-level docstrings for simulation module

e8a3a8d

harshkhandeparkar force-pushed the simulation-module branch from 4e387fa to e8a3a8d Compare September 11, 2023 15:34

refactor: renamed python test workflow

8297c83

msaligane approved these changes Sep 25, 2023

View reviewed changes

msaligane merged commit 76737b5 into idea-fasoc:main Sep 25, 2023

saicharan0112 mentioned this pull request Oct 1, 2023

Update README.rst and add docker exit code inside workflows [CI] #240

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GSoC] Common Python Simulation module #226

[GSoC] Common Python Simulation module #226

harshkhandeparkar commented Aug 9, 2023 •

edited

Loading

saicharan0112 left a comment

harshkhandeparkar commented Aug 23, 2023

saicharan0112 left a comment

msaligane Sep 7, 2023

harshkhandeparkar Sep 7, 2023

saicharan0112 Sep 9, 2023

msaligane Sep 7, 2023

msaligane Sep 7, 2023

harshkhandeparkar Sep 7, 2023

saicharan0112 Sep 9, 2023

msaligane Sep 7, 2023

harshkhandeparkar Sep 7, 2023

harshkhandeparkar Sep 7, 2023

saicharan0112 Sep 9, 2023 •

edited

Loading

saicharan0112 left a comment

harshkhandeparkar commented Sep 10, 2023

msaligane commented Sep 11, 2023

harshkhandeparkar commented Sep 11, 2023

saicharan0112 commented Oct 1, 2023

harshkhandeparkar commented Oct 1, 2023

saicharan0112 commented Oct 1, 2023

saicharan0112 commented Oct 1, 2023

harshkhandeparkar commented Oct 2, 2023

saicharan0112 commented Oct 2, 2023

[GSoC] Common Python Simulation module #226

[GSoC] Common Python Simulation module #226

Conversation

harshkhandeparkar commented Aug 9, 2023 • edited Loading

Changes

Features of the Simulation Module

Screenshots

saicharan0112 left a comment

Choose a reason for hiding this comment

harshkhandeparkar commented Aug 23, 2023

saicharan0112 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

saicharan0112 Sep 9, 2023 • edited Loading

Choose a reason for hiding this comment

saicharan0112 left a comment

Choose a reason for hiding this comment

harshkhandeparkar commented Sep 10, 2023

msaligane commented Sep 11, 2023

harshkhandeparkar commented Sep 11, 2023

saicharan0112 commented Oct 1, 2023

harshkhandeparkar commented Oct 1, 2023

saicharan0112 commented Oct 1, 2023

saicharan0112 commented Oct 1, 2023

harshkhandeparkar commented Oct 2, 2023

saicharan0112 commented Oct 2, 2023

harshkhandeparkar commented Aug 9, 2023 •

edited

Loading

saicharan0112 Sep 9, 2023 •

edited

Loading