ECSHackWeek / impedance.py

A Python package for working with electrochemical impedance data
MIT License
205 stars 102 forks source link

generate quality circuit diagrams #13

Open mdmurbach opened 5 years ago

mdmurbach commented 5 years ago

Have had a few requests for the ability to export a circuit to a pdf/svg/png

After some poking around I think SchemDraw (https://cdelker.bitbucket.io/SchemDraw/SchemDraw.html) seems like a good way to do it

mdmurbach commented 5 years ago

scbarton got a pretty sweet draw_circuit function started in #25. Testing more complex functions and documentation could be a great first contributor/Hack Week project.

dacb commented 4 years ago

I have code from our last hack week that mostly implements this. One of the problems is that not all elements are represented in the circuit library in SchemDraw, IIRC. I'll try to make time to review this over the next week. It is also against a nearly one year old fork so that will need to reconciled.

mdmurbach commented 4 years ago

Great! Let me know if/how I can help

beckdac commented 4 years ago

Writing good tests is going to be a challenge.

mdmurbach commented 4 years ago

Yeah... I could see that.

I think it'd be possible to come up with some edge cases (nested parallel/series elements, etc.) but testing/ensuring that it works globally seems challenging. Maybe we just check the circuit complexity and warn the user if it's beyond a typical (i.e. tested) use case. Realistically, there are physical constraints on what complexity of circuit makes sense if that's helpful.

Yugal0 commented 12 months ago

The circuit drawing feature is not yet there in the library, right? or it is that I have an older distribution, Also, can someone tell me what the schedule is for releasing a new distribution of the library on pip (the python package installer).