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

Sub-compartments (#84) #116

Merged
merged 7 commits into from
Jan 5, 2022
Merged

Sub-compartments (#84) #116

merged 7 commits into from
Jan 5, 2022

Conversation

Quantalabs
Copy link
Member

Checklist:

  • Title is meaningful
  • Followed Contributing Guidelines
  • No new issues, pre-existing issues in the repo are okay. We just don't want faulty code to be published to the nightly build or main if it can be prevented
  • All new dependencies are added to [package.json]

Overview

Adds sub compartment functionality to EpiJS. This brings breaking changes, and will be shipped with v3, after #115 and #83 are implemented, along with other functionality.

File Changelist

  • EpiJS/comp.js
    • Add sub-compartments with .addSub method for all compartments.
    • Get sub-compartment populations with .getSubData method for all compartments.
  • EpiJS/model.js
    • Change .get_data method to include sub-compartment data if it exists.
  • tests/scripts/com.js
    • Update community modelling testing to include sub-compartments
  • tests/scripts/comp.js
    • Add testing for sub-compartments with the comp module
  • tests/scripts/model.js
    • Update testing to include sub-compartments with model module
  • web/index.min.js
    • Rebuild code with updates to the comp and model modules.

Other Notes

Important: This PR brings breaking changes which, though minor, can cause errors in your code. We highly encourage you check out these changes before running code with this again.

Closes #84

Adds the initial code for subcompartments to be worked on in future commits, rebuilds code, and adds testing for subcompartments.
Fix minor bug in subcompartments that returned an object as population, even when there were no subcompartments.
@Quantalabs Quantalabs self-assigned this Jan 5, 2022
@github-actions github-actions bot added the src Directly related to the source code of the package label Jan 5, 2022
@Quantalabs Quantalabs added enhancement New feature or request src Directly related to the source code of the package and removed src Directly related to the source code of the package labels Jan 5, 2022
@Quantalabs Quantalabs enabled auto-merge (squash) January 5, 2022 20:40
Copy link
Member

@quantum9Innovation quantum9Innovation left a comment

Choose a reason for hiding this comment

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

🛥️

@Quantalabs Quantalabs merged commit 0a200ad into main Jan 5, 2022
@Quantalabs Quantalabs deleted the v3-development branch January 5, 2022 20:48
@Quantalabs Quantalabs restored the v3-development branch January 5, 2022 20:50
@Quantalabs Quantalabs deleted the v3-development branch January 5, 2022 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request src Directly related to the source code of the package
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Feature - Sub-compartments
2 participants