search

AguaClara / aide

AguaClara Infrastructure Design Engine - a software tool that designs AguaClara water treatment plants and their components.
MIT License
0 stars 0 forks source link

Documentation Engine #14

Closed oliver-leung closed 4 years ago

oliver-leung commented 5 years ago

One of the goals for AIDE is to add functionality for generating completed documentation on building and maintaining the plant. As per @monroews's request, we will be reviving the work of AIDE Document (and this repo) and tying it directly to the functionality of AIDE.

Documentation templates (from which completed documentation will be generated) will take on the form of RST files, due to RST's ability to render LaTeX equations. Hopefully, we will be able to add images from Onshape 3D models and insert them directly into these doc templates. Click here to download an example documentation template in Spanish.

Looking to the future, my vision is that the aguaclara package will remain as it is currently - a library of functions for water treatment research and design code. AIDE (which will reside in this repo) will become a GUI-based application (run either locally or in an online web application), and will be a nexus between the aguaclara design code, a documentation engine, and Onshape.

oliver-leung commented 4 years ago

Being worked on in AIDE: Design Specs