Requirement for a proper documentation of the software.

[gauravity30]

I personally feel, there is a great need of proper documentation of the software for beginners. The current documentation can be expanded to cover all the new aspects and FAQs. More information about the statistics and visu output is required. This is just a suggestion. If required I can volunteer for the same.

Thanks,
Gaurav

[gauravity30]

Hey @mathrack !
I saw the help needed flag on the issue. I can help you with the documentation, if required.

Regards,
Gaurav

[mathrack]

The code is huge and most of the modules / variables / subroutines are not really documented or described with comments.

@airwarriorg91 if you are familiar with a part of the code, you can add some comments to help other understand the code.

cheers,
mathrack

[gauravity30]

Hii,
Is there any format I need to use for the documentation ?

Regards,
Gaurav

[mathrack]

The main documentation is located here :
https://xcompact3d.readthedocs.io/en/latest/
https://github.com/xcompact3d/Incompact3d/tree/master/docs

The documentation is also located in the comments in the code.