MadNLP / DynamicNLPModels.jl

NLPModels for dynamic optimization
MIT License
11 stars 1 forks source link

Added Documentation, Readme, and applied JuliaFormatter #46

Closed dlcole3 closed 2 years ago

dlcole3 commented 2 years ago

I fixed the doc strings in the source code so that it now compiles correctly within the documentation. I also updated the guide and index markdown files for the introduction and quick start sections of the documentation. I added a readme file. I also updated the examples folder because it was using old formatting for MadNLP and MadNLPGPU. The old exmaple also used the 1D temperature control problem, but this problem was not using correct boundary conditions, so I replaced it with a simpler version that will at least give the users an idea of how to run the problem with the GPU.

I also ran JuliaFormatter on all the source code.

There is likely more I can add to the documentation later, but I wanted to get some initial docs pushed.