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

Add documentation based on readthedocs #60

Open
dachengx opened this issue Jul 26, 2023 · 1 comment
Open

Add documentation based on readthedocs #60

dachengx opened this issue Jul 26, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers make user-friendly

Comments

@dachengx
Copy link
Collaborator

dachengx commented Jul 26, 2023

Examples, tutorials, usage of:

  1. Parameters
  2. BlueiceDataGenerator
  3. StatisticalModel, particularly the degree of freedom of required attributes and functions, like the type of data
  4. BlueiceExtendedModel

and required format of statistical model and runner configuration:

  1. what keys are needed
  2. rate and shape parameters
  3. parameter of interest

We now have BlueiceExtendedModel which is designed based on blueice. It will be beneficial to clearly describe the structure of BlueiceExtendedModel instance, like its attributes and attributes of its attributes. I believe some of them should be in blueices's documentation, but also good to first implement here.

@dachengx dachengx self-assigned this Jul 26, 2023
@kdund kdund added documentation Improvements or additions to documentation good first issue Good for newcomers make user-friendly labels Jul 27, 2023
@hammannr
Copy link
Collaborator

I think one of the very important pieces of information that we should document well is how to properly write a config file for the BlueiceExtendedModel and what options you have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers make user-friendly
Projects
None yet
Development

No branches or pull requests

3 participants