FreeCAD Logo FreeCAD 1.0
  • English Afrikaans Arabic Belarusian Catalan Czech German Greek Spanish Spanish Basque Finnish Filipino French Galician Croatian Hungarian Indonesian Italian Japanese Kabyle Korean Lithuanian Dutch Norwegian Bokmal Polish Portuguese Portuguese Romanian Russian Slovak Slovenian Serbian Swedish Turkish Ukrainian Valencian Vietnamese Chinese Chinese
  • Features
  • Download
  • Blog
  • Documentation
    Documentation index Getting started Users documentation The FreeCAD manual Workbenches documentation Python coding documentation C++ coding documentation Tutorials Frequently asked questions Privacy policy About FreeCAD
  • Contribute
    How to help Sponsor Report a bug Make a pull request Jobs and funding Contribution guidelines Developers handbook Translations
  • Community
    Code of conduct Forum The FPA GitHub GitLab Codeberg Mastodon Matrix IRC IRC via Webchat Gitter Discord Reddit Twitter Facebook LinkedIn Calendar
  • ♥ Donate

Donate

$
SEPA Information
Please set up your SEPA bank transfer to:
Beneficiary: The FreeCAD project association
IBAN: BE04 0019 2896 4531
BIC/SWIFT: GEBABEBBXXX
Bank agency: BNP Paribas Fortis
Address: Rue de la Station 64, 1360 Perwez, Belgium

While Stripe doesn't support monthly donations, you can still become a sponsor! Simply make a one-time donation equivalent to 12 months of support, and you'll gain access to the corresponding sponsoring tier. It's an easy and flexible way to contribute.

If you are not sure or not able to commit to a regular donation, but still want to help the project, you can do a one-time donation, of any amount.

Choose freely the amount you wish to donate one time only.

You can support FreeCAD by sponsoring it as an individual or organization through various platforms. Sponsorship provides a steady income for developers, allowing the FPA to plan ahead and enabling greater investment in FreeCAD. To encourage sponsorship, we offer different tiers, and unless you choose to remain anonymous, your name or company logo will be featured on our website accordingly.

from 1 USD / 1 EUR per month. You will not have your name displayed here, but you will have helped the project a lot anyway. Together, normal sponsors maintain the project on its feet as much as the bigger sponsors.

from 25 USD / 25 EUR per month. Your name or company name is displayed on this page.

from 100 USD / 100 EUR per month. Your name or company name is displayed on this page, with a link to your website, and a one-line description text.

from 200 USD / 200 EUR per month. Your name or company name and logo displayed on this page, with a link to your website and a custom description text. Companies that have helped FreeCAD early on also appear under Gold sponsors.

Instead of donating each month, you might find it more comfortable to make a one-time donation that, when divided by twelve, would give you right to enter a sponsoring tier. Don't hesitate to do so!

Choose freely the amount you wish to donate each month.

Please inform your forum name or twitter handle as a notein your transfer, or reach to us, so we can give you proper credits!

IPython notebook integration

This page is dedicated to the Google Summer of Code project regarding the interoperability between IPython and FreeCAD, mostly regarding visualisation.

Outline

FreeCAD is quite popular for its extensive Python API providing grounds for many advanced macros and extensions. The API, which exposes everything from the document structure, basic workbench specific types and even the whole GUI, offers large amounts of freedom for the user to create everything he wants. Python in itself has become increasingly popular in the scientific community over the last years, partially surpassing classical interpreted languages like Matlab in certain areas. Due to this increased interest in and usage of the language an ecosystem for scientific computation has evolved around Python, leading to advanced coding environments like IPython and its Jupyter notebook. As this scientific usage of the language fits very well into FreeCADs profile as a python driven CAx application it should be possible to tightly integrate it into the scientific workflow. This means less usage of a custom application GUI but good integration into multi-purpose computation environments like IPython.

FreeCAD\'s API in itself is solid and powerful enough to be used in IPython extensively, however, one main issue with CAx code is the visualisation. It is nearly impossible to develop 3D models without seeing them. It is therefore important to find a way to visualize FreeCAD\'s 3D scene in the IPython display system as supported by the IPython QTConsole and the Jupyter notebook.

Details

  1. Get familiar with FreeCADs openinventor scenegraph and the basic working of the GUI module. Also learn the openinventor API and the scene graph structure it provides.
  2. Find a JavaScript library which makes it easy to create 3D scene graphs via WebGL and analyse how the nodes can be mapped to the open inventor scene graph nodes. A good candidate is SceneJS
  3. Write a openinventor action writing the JavaScript file which mimics the scene graph from the open inventor representation
    1. It should export geometry nodes as well as material (color etc.), lightning and camera
    2. Advanced: Implement a replacement for all openinventor nodes
  4. Create a real JavaScript 3D viewer which mimics FreeCAD viewer
    1. It should support 3D navigation, standard views (top, bottom,...)
    2. Advanced: It should mimic the FreeCAD preselection, e.g. show edges, faces and vertices as they are in FreeCAD
    3. Advanced: It should show the correct geometry names as in FreeCAD when preselected
    4. Advanced: Implement multiple navigation modes
  5. Extend FreeCAD with functions returning an IPython compatible version of the created JavaScript 3D viewer
  6. Replace the current WebGL export with the new advanced component

Expected Outcome

  1. The possibility to easily show FreeCAD document objects in Jupyter without needing to fire up the FreeCAD GUI
  2. The possibility to comfortably navigate the 3D scene inside of Jupyter
  3. Better WebGL export
  4. Documentation of the FreeCAD IPython interoperability in the Wiki and an example Jupyter notebook.

Future Possibilities

If the 3D scene can be navigated other things, which FreeCAD can display, remain, for example the spreadsheet.

Project Properties

Skills

  • Programming language mainly C++ and JavaScript
  • Understand and use APIs from FreeCAD and external libraries like openinventor

Difficulty

Easy

Additional Information

  • Ticket on FreeCAD bug tracker: #2869
  • A FreeCAD kernel for Jupyter: looooo/jupyter_freecad_kernel
  • Dedicated discussion: IPython notebook integration
  • Thread discussion: How to use Jupyter Notebook with FreeCad (Guide)
  • Thread discussion: Embedding FreeCAD in IPython
  • Thread discussion: Has Anyone successfully connected to FC thru Jupyter ?
  • Thread discussion: IPython Qt Console

GSoC 2020

This project was chosen for GSoC 2020. The results can be found here: Git repo. The corresponding thread in the FreeCAD forum can be found here. Find a blog post here. The full project proposal can be found here. The results are a good base to build upon.

⏵ documentation index > IPython notebook integration

This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/IPython_notebook_integration.md

Get in touch!
Forum GitHub Mastodon Matrix IRC Gitter.im Discord Reddit Twitter Facebook LinkedIn

© The FreeCAD Team. Homepage image credits (top to bottom): ppemawm, r-frank, epileftric, regis, rider_mortagnais, bejant.

This project is supported by: , KiCad Services Corp. and other sponsors

GitHubImprove this page on GitHub