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.

Sign up for GitHub

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

Jump to bottom

Documentation (lack of) #1

Open
JaminMartin opened this issue Aug 9, 2023 · 3 comments
Open

Documentation (lack of) #1

JaminMartin opened this issue Aug 9, 2023 · 3 comments
Assignees
@JaminMartin
Labels
documentation Improvements or additions to documentation

Comments

@JaminMartin
Copy link
Owner

No documentation outlining the use of each function in this library.
@JaminMartin JaminMartin added the documentation Improvements or additions to documentation label Aug 9, 2023
@JaminMartin JaminMartin self-assigned this Aug 9, 2023
@JaminMartin
Copy link
Owner Author

The tutorial is written, I just need to work on function documentation in the actual code.

@JaminMartin
Copy link
Owner Author

Documentation for the structure and fitmc sub modules has been completed.

helper_funcs is in a constant state of flux so is still a work in progress.

Noted quite a few typos in readme documentation to address.

@JaminMartin
Copy link
Owner Author

Need to add:

  • updated docs on file caching
  • solvers
  • alternative plotting (browser)
  • install recommendations

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JaminMartin JaminMartin

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JaminMartin