search

JuliaTopOpt / TopOpt.jl

A package for binary and continuous, single and multi-material, truss and continuum, 2D and 3D topology optimization on unstructured meshes using automatic differentiation in Julia.
https://juliatopopt.github.io/TopOpt.jl/
Other
183 stars 30 forks source link

[doc] explain truss input file format in documentation #138

Closed yijiangh closed 1 year ago

pitipatw commented 1 year ago

I made a json file to input data from Grasshopper through WebSockets to Julia. I think I might able to help on this

yijiangh commented 1 year ago

@pitipatw That's awesome! The corresponding page in our doc is here and the source here.

In case you are not familiar with doc generation in Julia, we use Documentor.jl for building the docs (from markdown to HTML files), and we have a make.jl file for triggering the generation. We also use Literate.jl for turning a .jl file directly into an example documentation. If the comments you write in the example script follows markdown syntax, it will be compiled into a nicely looking webpage with all the outputs rendered (like what you would see in a jupyter notebook). @pitipatw, I would suggest that you start by adding some comments on the JSON keys and value format in our truss file in the source file here. And maybe remove the print(JSON.json(f, 2)); - I think it is occupying too much space on the doc page.

pitipatw commented 1 year ago

Copy that.