Skidl Jupyter book #153
Replies: 11 comments 22 replies
-
|
That's a good idea!
I previously made a notebook to show how to use skidl to do spice
simulations. I've also been thinking about using notebooks to explain the
list of "nifty fifty" transistor circuits.
…On Sun, Jul 10, 2022, 1:00 PM shanemmattner ***@***.***> wrote:
@devbisme <https://github.com/devbisme> what do you think of taking the skidl
documentation <https://devbisme.github.io/skidl/> and putting it into a Jupyter
book <https://jupyterbook.org/en/stable/intro.html>? I've been helping to
write a Jupyter book for Plotly Dash
<https://open-resources.github.io/dash_curriculum/intro.html> and it
turned out really well.
—
Reply to this email directly, view it on GitHub
<#153>, or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAFCXYHA33TRNMOZHUHFVX3VTL6UDANCNFSM53FJARDA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Beta Was this translation helpful? Give feedback.
-
|
Great! Here's a link to the book. I'll plan on copying over everything you have in this SKiDL page. Let me know if there's anything you'd like changed/updated. |
Beta Was this translation helpful? Give feedback.
-
|
Looks good. Let's just go with whatever is in the current master branch
documentation.
…On Tue, Jul 12, 2022, 1:11 AM shanemmattner ***@***.***> wrote:
Great! Here's a link
<https://shanemmattner.github.io/skidl_jupyter_book/intro.html> to the
book. I'll plan on copying over everything you have in this SKiDL page
<https://devbisme.github.io/skidl/>. Let me know if there's anything
you'd like changed/updated.
—
Reply to this email directly, view it on GitHub
<#153 (reply in thread)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAGOOG6KOSC6WFAVPKJDLFLVTT473ANCNFSM53FJARDA>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Beta Was this translation helpful? Give feedback.
-
|
@devbisme all done. Take a look and let me know what you think. I'm going to add the spice sim intro chapter as well https://shanemmattner.github.io/skidl_jupyter_book/intro.html |
Beta Was this translation helpful? Give feedback.
-
|
Wow, that looks really, really good! I like having the chapters listed in the left column and the subsections appearing in the right column. And there's even a search feature! How easy is it to add executable code cells to the book so the reader can try things? This would be great with the SPICE examples, but requires interfacing to an ngspice executable which might be tricky. |
Beta Was this translation helpful? Give feedback.
-
|
It is possible and I've got it kinda working: Go to chapter 1 and click the rocket ship in the upper right corner and click What's interesting is that when the book loads we see the correct value being printed out: However, when you do |
Beta Was this translation helpful? Give feedback.
-
|
What do you think of making SKiDL's default Also, is there a way to set the |
Beta Was this translation helpful? Give feedback.
-
|
I imagine when Jupyter Book compiles the document, it probably has access to your local KiCad library and than caches the results in the final HTML. But local files can't be accessed for security reasons when the Live Code button is pressed in the browser? I'll work on getting SKiDL to use the library repositories on Gitlab. That's a good idea. |
Beta Was this translation helpful? Give feedback.
-
|
I added the ability to read KiCad symbol libraries from the Gitlab remote repositories. To access V5 symbols, add the following to the list in For V6, use: |
Beta Was this translation helpful? Give feedback.
-
|
Looks like it's working. I moved my KiCAD schematic files and tried to run my example code which gave an error: Then I added the line below and the netlist generated fine: lib_search_paths[KICAD].append("https://gitlab.com/kicad/libraries/kicad-symbols/-/raw/master")SKiDL output: |
Beta Was this translation helpful? Give feedback.
-
|
Although I still can't get the example to run in the Jupyter book using this script: !pip install git+https://github.com/devbisme/skidl@development
!export KICAD_SYMBOL_DIR="https://github.com/shanemmattner/skidl_jupyter_book/tree/master/jupyter_book/symbols"
from skidl import *
lib_search_paths[KICAD].append("https://gitlab.com/kicad/libraries/kicad-symbols/-/raw/master")
resistor = Part('Device','R')
resistor.value = '1K'
resistor.valueI get the same error as I have with |
Beta Was this translation helpful? Give feedback.
-
|
Yes, I'm getting this same error. Time to add some debugging statements... |
Beta Was this translation helpful? Give feedback.
-
|
I made a |
Beta Was this translation helpful? Give feedback.
-
|
This Google Colab script can install the specific branch and works fine. !pip install git+https://github.com/devbisme/skidl@development
from skidl import *
lib_search_paths[KICAD].append("https://gitlab.com/kicad/libraries/kicad-symbols/-/raw/master")
resistor = Part('Device','R', footprint='Resistor_SMD:R_0603_1608Metric')
resistor.value = '1K'
resistor.value
generate_netlist(file_='test.net')Console output: This experiment shows another possible improvement: auto source footprints if the user doesn't have the appropriate libraries installed. |
Beta Was this translation helpful? Give feedback.
-
|
So this is an error within Jupyter Book? Also, in your colab output, I'm not sure why there are missing footprint errors. The footprint is clearly specified in the |
Beta Was this translation helpful? Give feedback.
-
|
I think the error is within We're probably getting the same error for footprints as we did for schematics: there's no local copy of the footprint library in the I'm guessing |
Beta Was this translation helpful? Give feedback.
-
|
SKiDL doesn't really check for footprint libraries. It doesn't complain as long as there is a string in the |
Beta Was this translation helpful? Give feedback.
-
|
Ah, I see. I think I found the source of those messages. Colab doesn't reset variables so if I previously declared the resistor without a footprint it will keep spamming the message: |
Beta Was this translation helpful? Give feedback.
-
|
I added a section on creating an ESP32 development board. Let me know what you think. |
Beta Was this translation helpful? Give feedback.
-
|
Won't that miss a pin off? Suggested slightly different fn: def breakout_ic(ic, header):
headers=[header]
counter = 1
# Iterate through IC pins in pin order and connect them to a header
for n in range(1, len(ic.pins) +1): # ic.pins may not be in footprint order
pin = ic[n]
headers[-1][counter] += pin
counter += 1
# Check if we've reached the end of the header
if counter > len(header.pins):
counter = 1
# Add another copy of the header to the list
headers.append(header.copy())
# Disconnect all the pins of the new header
for i in headers[-1].pins:
i.disconnect()correcting (?) the iteration, and explaining why we don't just iterate ic.pins directly for newbies like me ;) |
Beta Was this translation helpful? Give feedback.
-
|
First of all, and most importantly, an end-to-end example like this is really good! I'm building a (sorely neglected) library of SKiDL modules over at circuitsascode. I'm hoping to add MCU modules like this one to it. I do have a couple of small suggestions:
|
Beta Was this translation helpful? Give feedback.
-
|
I didn't want to miss out on the fun of writing the from skidl import *
esp32 = esp32 = Part('RF_Module','ESP32-WROOM-32', footprint='RF_Module:ESP32-WROOM-32')
# Create a template that can be used to make copies of the breakout header.
header = Part('Connector', 'Conn_01x05_Male', footprint='Connector_PinHeader_2.54mm:PinHeader_1x05_P2.54mm_Vertical', dest=TEMPLATE)
def breakout_ic(ic, header):
# Create a list for breakout headers.
headers = []
# Get all the IC pins in order.
all_ic_pin_nums = list(range(1, len(ic)+1))
# Break the IC pins into small lists that fit an individual header and make connections.
for ic_pin_nums in [all_ic_pin_nums[i:i+len(header)] for i in range(0,len(ic),len(header))]:
# Get the header pin numbers 1,2,...,N that match up with the current IC pin numbers.
hdr_pin_nums = list(range(1,len(ic_pin_nums)+1))
# Add a new header to the end of the list using the header template.
headers.append(header())
# Connect the header at the end of the list to the IC pins.
headers[-1][hdr_pin_nums] += ic[ic_pin_nums]
# Add breakout headers to the ESP32.
breakout_ic(esp32, header)
# Print out the connections to see if we did it right.
for pin in esp32:
print(f"Connection: {pin.net}") |
Beta Was this translation helpful? Give feedback.
-
|
@2e0byo for pin in esp32.pins:
print(str(pin)) |
Beta Was this translation helpful? Give feedback.
-
|
Oh indeed: I added a comment once I figured that out. But you're still missing a pin, right? |
Beta Was this translation helpful? Give feedback.
-
|
@devbisme your To respond to your other ideas:
def r(value, p1, p2, footprint='Resistor_SMD:R_0603_1608Metric'):
r = Part('Device', 'R', value=value, footprint=footprint)
p1 & r & p2 |
Beta Was this translation helpful? Give feedback.
-
Agreed, but I would change your code to accept a
Thanks, I'll check into it.
Agreed, but I'm not keen on the |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
In the unlikely event the maintainers decide they want #156 in skidl, you can just iterate .pins directly. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for offering to do this! I made a comment to your PR. |
Beta Was this translation helpful? Give feedback.
-
|
For the record in this issue this became #157. When it gets merged you can do: for pin in thing.ordered_pins:
...I'll not rewrite |
Beta Was this translation helpful? Give feedback.
-
|
I pushed the changes for |
Beta Was this translation helpful? Give feedback.
-
@devbisme what do you think of taking the skidl documentation and putting it into a Jupyter book? I've been helping to write a Jupyter book for Plotly Dash and it turned out really well.
Beta Was this translation helpful? Give feedback.
All reactions