FEM documentation missing on the Wiki

About the development of the FEM module/workbench.

Moderator: bernd

chrisb
Posts: 28938
Joined: Tue Mar 17, 2015 9:14 am

Re: FEM documentation missing on the Wiki

Post by chrisb » Wed Mar 13, 2019 12:36 am

If you want to have easy to use and easy to understand "ping", please follow this post and vote: https://forum.freecadweb.org/viewtopic.php?f=8&t=34742.
A Sketcher Lecture with in-depth information is available in English, auf deutsch, en français, en español.
User avatar
bernd
Posts: 10956
Joined: Sun Sep 08, 2013 8:07 pm
Location: Zürich, Switzerland

Re: FEM documentation missing on the Wiki

Post by bernd » Thu Mar 14, 2019 3:40 pm

did the https://www.freecadweb.org/wiki/Release ... _Workbench ... Despite the 8 month of development there where nearly no new tools in FEM :shock: But there was done lots of work on the FEM code base :mrgreen: which will help to even improve FEM much more in 0.19
User avatar
uwestoehr
Posts: 1950
Joined: Sun Jan 27, 2019 3:21 am

Re: FEM documentation missing on the Wiki

Post by uwestoehr » Thu Mar 14, 2019 11:04 pm

bernd wrote:
Thu Mar 14, 2019 3:40 pm
did the https://www.freecadweb.org/wiki/Release ... _Workbench ...
Many thanks!
User avatar
Kunda1
Posts: 8710
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Post by Kunda1 » Mon Jan 13, 2020 9:21 pm

Kunda1 wrote:
Tue Feb 21, 2017 12:28 pm
(see previous post)
@Bernd, I'm going over this list. I fixed the problem with the URLs so they now resolve correctly. Please ignore the Legend and emojis for now.
What is needed:
  • When each FEM command was introduced
  • Adding Descriptions to commands (that don't have one already)
  • Adding How to use info for each command (that doesn't have one already)
  • Adding Properties for each command (that doesn't have one already)
  • Adding Options for each command (that doesn't have one already)
  • Adding Limitations section
  • Adding Scripting sections for those that don't have
Edit: All FEM wiki pages have been added to the OP list
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
Kunda1
Posts: 8710
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Post by Kunda1 » Tue Jan 14, 2020 9:53 pm

:point_up_2:
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
ebrahim raeyat
Posts: 354
Joined: Sun Sep 09, 2018 7:00 pm
Location: Iran
Contact:

Re: FEM documentation missing on the Wiki

Post by ebrahim raeyat » Mon Apr 06, 2020 10:09 am

@Kunda1, @bernd. is it possible to use readthedocs for documenting. i see most of the software use that for documentation, like ezdxf library, this one and this.

i think we must provide a good API document for FEM WB
User avatar
Kunda1
Posts: 8710
Joined: Thu Jan 05, 2017 9:03 pm

Re: FEM documentation missing on the Wiki

Post by Kunda1 » Mon Apr 06, 2020 12:52 pm

David_D is doing some that could be used to generate Sphinx documentation
https://forum.freecadweb.org/viewtopic. ... 12#p381156
https://github.com/DavidDaish/FreeCAD/t ... -docstring
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
ebrahim raeyat
Posts: 354
Joined: Sun Sep 09, 2018 7:00 pm
Location: Iran
Contact:

Re: FEM documentation missing on the Wiki

Post by ebrahim raeyat » Fri Apr 10, 2020 11:16 am

Kunda1 wrote:
Mon Apr 06, 2020 12:52 pm
David_D is doing some that could be used to generate Sphinx documentation
https://forum.freecadweb.org/viewtopic. ... 12#p381156
https://github.com/DavidDaish/FreeCAD/t ... -docstring
thanks, but i can't create sphinx export freecad document, only doxygon.
User avatar
Sudhanshu
Posts: 355
Joined: Mon Oct 15, 2018 5:22 am

Re: FEM documentation missing on the Wiki

Post by Sudhanshu » Wed Aug 05, 2020 7:41 pm

Hello,
In the ongoing GSoC project "FEM Examples Extension", we have created a GUI that opens the examples and have added new examples too.
I would like to make wiki pages for the new GUI and some examples (especially those that require some post processing to get appreciated).
And after I am comfortable with creating wiki pages for FreeCAD, I can even try to complete the missing documentation.

But I am not sure if this is the right thread.
Please guide me for this. :)
Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest