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

Reorganise source code #129

Merged
merged 2 commits into from
Mar 8, 2024
Merged

Reorganise source code #129

merged 2 commits into from
Mar 8, 2024

Conversation

SamuelBrand1
Copy link
Collaborator

@SamuelBrand1 SamuelBrand1 commented Mar 8, 2024

This DRAFT PR is aimed at addressing #125.

Goals

Reorganise the source code into sub-directories for

  • utilities
  • epi models
  • latent models
  • observation models
  • inference methods

With only abstract types and back-stop dispatches on them in /src. Each implementation of a model indicated by type (e.g direct infection epi model) should have its own file.

Closes #125

EDIT: actually I think this is better scoped to just reorganise, but it will make it easier to sub-task docstrings so therefore contribute to #35 and other issues.

@SamuelBrand1 SamuelBrand1 linked an issue Mar 8, 2024 that may be closed by this pull request
@SamuelBrand1 SamuelBrand1 changed the title refactor source code Reorganise source code Mar 8, 2024
@SamuelBrand1 SamuelBrand1 marked this pull request as ready for review March 8, 2024 15:15
@SamuelBrand1 SamuelBrand1 requested a review from seabbs March 8, 2024 15:15
@SamuelBrand1
Copy link
Collaborator Author

Only effect on documentation is to change the doc template here.

Reason for change is that we are trying to (possibly loosely) follow SciML documentation convention here, and this change to template better matches their style.

@seabbs seabbs enabled auto-merge March 8, 2024 16:10
Copy link
Collaborator

@seabbs seabbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I think we should go oone step further here and use submodules so will propose a PR for this.

EpiAware/src/EpiAware.jl Show resolved Hide resolved
@seabbs seabbs merged commit 178e3ae into main Mar 8, 2024
10 checks passed
@seabbs seabbs deleted the 125-code-organisation branch March 8, 2024 17:05
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

Successfully merging this pull request may close these issues.

Code organisation
2 participants