Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/API somewhere? #117

Open
jnahlers opened this issue Dec 20, 2023 · 4 comments
Open

Docs/API somewhere? #117

jnahlers opened this issue Dec 20, 2023 · 4 comments

Comments

@jnahlers
Copy link

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

@dkazanc
Copy link
Owner

dkazanc commented Dec 20, 2023

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
Copy link
Owner

dkazanc commented Dec 22, 2023

Hi please find all API references here. thanks!

@jnahlers
Copy link
Author

@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.

@dkazanc
Copy link
Owner

dkazanc commented Jan 3, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants