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

Improve documentation #583

Open
1 of 8 tasks
kordejong opened this issue Aug 7, 2023 · 0 comments
Open
1 of 8 tasks

Improve documentation #583

kordejong opened this issue Aug 7, 2023 · 0 comments

Comments

@kordejong
Copy link
Member

kordejong commented Aug 7, 2023

Keep this issue open and use the associated branch to work on documentation. Once in a while merge the content into the master branch, using a PR, but keep the branch open and use new PRs over time.

Content to add:

  • Add initial documentation for creating and executing simulation models
  • Man-pages for the framework operations. For this we need to have a public API defined. See also Harmonize public C++ and Python APIs #639
  • Policies
  • Howto for adding a new local operation to LUE itself
  • Howto for creating custom local operation, using LUE as 3rd party library
  • List potential use-case for LUE, besides using it as is for model development
  • How to use lue_qa for performance and scalability analyses
  • ...
@kordejong kordejong added this to the 0.3.8 milestone Aug 7, 2023
@kordejong kordejong modified the milestones: 0.3.8, 0.3.9 Mar 12, 2024
@kordejong kordejong self-assigned this Jul 18, 2024
@kordejong kordejong removed this from the 0.3.9 milestone Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant