TomoPhantom icon indicating copy to clipboard operation
TomoPhantom copied to clipboard

Docs/API somewhere?

Open jnahlers opened this issue 2 years ago • 4 comments

Great software! I may have missed this, but is there some documentation and/or API reference somewhere?

jnahlers avatar Dec 20 '23 00:12 jnahlers

Thanks, I'm currently refactoring software to make various development related processes much easier. With that I'm hoping of adding proper Documentation page on Github Pages. Hopefully it will go live in the next couple of days. For now you can have a look at some of API bits mentioned in the paper. Will update the issue, when Docs are live.

dkazanc avatar Dec 20 '23 09:12 dkazanc

Hi please find all API references here. thanks!

dkazanc avatar Dec 22 '23 11:12 dkazanc

@dkazanc The one thing I'm still not sure about is the various object parameters (e.g. Obj, a, phi1, C0, etc.). Perhaps it would be good to include a list of all of them, what they do, and what values they can take somewhere in the docs.

jnahlers avatar Dec 27 '23 06:12 jnahlers

thanks, it does indeed will be helpful to describe. Will try to find some time to do it at some point :)

dkazanc avatar Jan 03 '24 14:01 dkazanc

Hi @jnahlers , some work has been done on Documentation recently. See specifically the bit about API of library files and objects. Hope it helps!

dkazanc avatar Jan 06 '25 17:01 dkazanc