Documentation on input parameters

[emichr]

I haven't found any documentation or docstrings in the functions and files of MULTEM. Is there any documentation other than the example files available or under development? If not, then perhaps we (the users) should initiate something based on experience/use?

[Quantumstud]

Hi,

I had a similar question. I started using MULTEM sometime back. It so seems that the description of the input parameters is present in the 'multem_default_values.' Then these parameters are quite closely related to the book by Kirkland.

I couldn't find any documentation apart from these. I think it is indeed an excellent idea for documentation of the code. Lucid documentations would also make future developments of the wonderful software package easier.

[emichr]

The descriptions in the multem_default_values are indeed very helpful but as you say, documentation of the code is very important for future developments!

At the moment, it is quite difficult to get an overview of all the parameters relevant for specific simulation modes. I would suggest starting out by creating a documentation based on the required inputs to il_MULTEM for each separate simulation mode. However, in my opinion, the end goal should be that all functions have descriptive and informative docstrings, and then a separate in-depth documentation of the implementations. This will be a large task though, but I think the code and community will benefit greatly from it.

[Ivanlh20]

You can find a small description of most TEM modes at https://github.com/Ivanlh20/MULTEM/blob/master/tutorial/Emat_workshop.pdf

El dom., 5 may. 2019 a las 3:11, Tara Prasad Mishra (< notifications@github.com>) escribió:

Hi,

I had a similar question. I started using MULTEM sometime back. It so seems that the description of the input parameters is present in the 'multem_default_values.' Then these parameters are quite closely related to the book by Kirkland.

I couldn't find any documentation apart from these. I think it is indeed an excellent idea for documentation of the code. Lucid documentations would also make future developments of the wonderful software package easier.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/Ivanlh20/MULTEM/issues/29#issuecomment-489377890, or mute the thread https://github.com/notifications/unsubscribe-auth/ACBRRNZM6QQ2PBXZYIF4EP3PTYX5JANCNFSM4HKZSWGQ .