Skip to content

Formatting and link fixes #76

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

Open
elsaesserevan wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Formatting and link fixes #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cad2fb5
Formatting and link fixes
elsaesserevan Jun 30, 2026
2422347
Merge branch 'main' into format-cleanup-2
elsaesserevan Jun 30, 2026
2d1e09a
Fix whitespace
elsaesserevan Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 81 additions & 71 deletions emodpy/campaign/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class CommonInterventionParameters:
Args:
cost (float, optional):
- The unit 'cost' per intervention distributed. For interventions distributed to people, the cost will be
added for each person. For internventions distributed to nodes, the cost is for each node. Setting
added for each person. For interventions distributed to nodes, the cost is for each node. Setting
cost to zero for all other interventions, and to a non-zero amount for one intervention, provides a
convenient way to track the number of times the intervention has been applied in a simulation.
- Minimum value: 0.
Expand All @@ -25,9 +25,9 @@ class CommonInterventionParameters:
disqualifying_properties (list[str], optional):
- A list of IndividualProperty 'key:value' pairs that will prevent an intervention from being distributed
or applied/updated (persistent interventions will abort/expire in the time step they see the change in
their individual property). See :ref:demo-properties parameters for more information. Generally used to
control the flow of health care access. For example, to prevent the same individual from accessing health
care via two different routes at the same time.
their individual property). See [Individual and Node Properties](https://emod.idmod.org/EMOD-Generic/md_parameter/parameter-demographics/#nodeproperties-and-individualproperties)
for more information. Generally used to control the flow of health care access. For example, to prevent
the same individual from accessing health care via two different routes at the same time.
- Defaults to None.

dont_allow_duplicates (bool, optional):
Expand All @@ -43,10 +43,10 @@ class CommonInterventionParameters:

new_property_value (str, optional):
- An optional IndividualProperty 'key:value' pair that will be assigned when the intervention is first
applied/updated. See :ref:demo-properties parameters for more information. Generally used to indicate the
broad category of health care cascade to which an intervention belongs to prevent individuals from
accessing care through multiple pathways. For example, if an individual must already be taking a
particular medication to be prescribed a new one.
applied/updated. See [Individual and Node Properties](https://emod.idmod.org/EMOD-Generic/md_parameter/parameter-demographics/#nodeproperties-and-individualproperties)
for more information. Generally used to indicate the broad category of health care cascade to which
an intervention belongs to prevent individuals from accessing care through multiple pathways. For example,
if an individual must already be taking a particular medication to be prescribed a new one.
- Defaults to None.

"""
Expand Down Expand Up @@ -121,8 +121,8 @@ class TargetGender(Enum):
class TargetDemographicsConfig:
"""
A class that is used to configure the Demographics_Coverage, Target_Demographic, Target_Age_Min, Target_Age_Max,
Target_Gender and Target_Residents_Only in the coordinator class. Please refer to emodpy.campaign.distributor
for its usage.
Target_Gender and Target_Residents_Only in the coordinator class. Please refer to [emodpy.campaign.distributor](https://emod.idmod.org/emodpy/autoapi/emodpy/campaign/distributor/)
for more information about its usage.

Args:
demographic_coverage (float, optional):
Expand All @@ -144,16 +144,18 @@ class TargetDemographicsConfig:

target_residents_only (bool, optional):
- When set to true, the intervention is only distributed to individuals that began the simulation in the node (i.e. those that claim the node as their residence).
- You can use the MigrateIndividuals function to modify an individual's HOME node. For more details on MigrateIndividuals, refer to the Emod documentation: [MigrateIndividuals](https://emod.idmod.org/emodpy-hiv/emod/parameter-campaign-individual-migrateindividuals/)
- You can use the MigrateIndividuals function to modify an individual's HOME node. For more details on MigrateIndividuals, refer to the [EMOD documentation](https://emod.idmod.org/EMOD-Generic/md_parameter/parameter-campaign-individual-migrateindividuals/)
- Defaults to False.

Examples:
# replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
Replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
```
from emodpy.campaign.common import TargetDemographicsConfig, TargetGender
from emodpy.campaign.distributor import add_intervention_scheduled
demographics_config = TargetDemographicsConfig(demographic_coverage=0.5, target_age_min=10,
target_age_max=20, target_gender=TargetGender.FEMALE)
add_intervention_scheduled(demographics_config=demographics_config, ...)
```
"""
class _TargetDemographic(Enum):
EVERYONE = "Everyone"
Expand Down Expand Up @@ -241,12 +243,13 @@ class RepetitionConfig:
ValueError: if timesteps_between_repetitions is undefined when number_repetitions is used.

Examples:
# replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
```
from emodpy.campaign.common import RepetitionConfig
from emodpy.campaign.distributor import add_intervention_scheduled
repetition_config = RepetitionConfig(number_repetitions=2, timesteps_between_repetitions=365)
add_intervention_scheduled(repetition_config=repetition_config, ...)

```
"""
def __init__(self, number_repetitions: int = 1, timesteps_between_repetitions: int = None,
infinite_repetitions: bool = False):
Expand Down Expand Up @@ -295,7 +298,6 @@ def _set_repetitions(self, campaign_object: s2c.ReadOnlyDict):

Returns:
This function does not return any value; instead, it modifies the campaign_object.

"""
if self.number_repetitions:
campaign_object.Number_Repetitions = self.number_repetitions
Expand All @@ -308,7 +310,7 @@ class PropertyRestrictions:
A class that is used to configure the individual property restrictions and node property restrictions in the
campaign object.

Please refer to the Emod documentation for NodeProperties and IndividualProperties parameters for more
Please refer to the EMOD documentation for NodeProperties and IndividualProperties parameters for more
information:

- HIV Emod: [Demographics parameters](https://emod.idmod.org/emodpy-hiv/emod/parameter-demographics/)
Expand Down Expand Up @@ -337,78 +339,87 @@ class PropertyRestrictions:
ValueError: if the elements in the inner list are not strings that represent dictionaries key:value pairs with at least one alphanumeric character before and after ':'.

Examples:
Example 1: This example demonstrates how to specify individual restrictions for targeting specific groups of people who are high risk AND whose InterventionStatus is ARTStaging.

# replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
Example 1: This example demonstrates how to specify individual restrictions for targeting specific groups
of people who are high risk AND whose InterventionStatus is ARTStaging.
```
replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
from emodpy.campaign.common import PropertyRestrictions
from emodpy.campaign.distributor import add_intervention_scheduled
property_restrictions = PropertyRestrictions(individual_property_restrictions=[["Risk:HIGH", "InterventionStatus:ARTStaging"]])
add_intervention_scheduled(property_restrictions=property_restrictions, ...)
# the result json should look like this:
# {
# "Property_Restrictions_Within_Node": [
# {
# "Risk": "HIGH",
# "InterventionStatus": "ARTStaging"
# }
# ]
# }


Example 2: This example demonstrates how to specify individual restrictions for targeting specific groups of people. In this case, we are targeting individuals whose InterventionStatus is set to ARTStaging and who have either HIGH or MEDIUM risk behavior. In other words, we aim to target individuals who meet either of the following conditions:

1. "InterventionStatus is set to ARTStaging and Risk is set to HIGH"
2. "InterventionStatus is set to ARTStaging AND Risk is set to MEDIUM"

# replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
```
the resulting json should look like this:
```
{
"Property_Restrictions_Within_Node": [
{
"Risk": "HIGH",
"InterventionStatus": "ARTStaging"
}
]
}
```
Example 2: This example demonstrates how to specify individual restrictions for targeting specific groups
of people. In this case, we are targeting individuals whose InterventionStatus is set to ARTStaging and who
have either HIGH or MEDIUM risk behavior. In other words, we aim to target individuals who meet either of
the following conditions:

1. InterventionStatus is set to ARTStaging and Risk is set to HIGH
2. InterventionStatus is set to ARTStaging AND Risk is set to MEDIUM
```
replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
from emodpy.campaign.common import PropertyRestrictions
from emodpy.campaign.distributor import add_intervention_scheduled
property_restrictions_within_node = PropertyRestrictions(
individual_property_restrictions=[
["Risk:HIGH", "InterventionStatus:ARTStaging"],
["Risk:MEDIUM", "InterventionStatus:ARTStaging"]])
add_intervention_scheduled(property_restrictions=property_restrictions, ...)
# the result json should look like this:
# {
# "Property_Restrictions_Within_Node": [
# {
# "Risk": "HIGH",
# "InterventionStatus": "ARTStaging"
# },
# {
# "Risk": "MEDIUM",
# "InterventionStatus": "ARTStaging"
# }
# ]
# }

```
the resulting json should look like this:
```
{
"Property_Restrictions_Within_Node": [
{
"Risk": "HIGH",
"InterventionStatus": "ARTStaging"
},
{
"Risk": "MEDIUM",
"InterventionStatus": "ARTStaging"
}
]
}
```
Example 3: This example demonstrates how to use 'node_property_restrictions' to specify the NodeProperty. In this case, we are targeting nodes that meet either of the following conditions:

1. "Risk is set to MEDIUM and Place is set to URBAN"
2. "Risk is set to LOW and Place is set to RURAL"

# replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
1. Risk is set to MEDIUM and Place is set to URBAN
2. Risk is set to LOW and Place is set to RURAL
```
replace emodpy with emodpy_hiv or emodpy_malaria based on the disease you are working on.
from emodpy.campaign.common import PropertyRestrictions
from emodpy.campaign.distributor import add_intervention_scheduled
property_restrictions = PropertyRestrictions(
node_property_restrictions=[
["Risk:MEDIUM", "Place:URBAN"],
["Risk:LOW", "Place:RURAL"]])
add_intervention_scheduled(property_restrictions=property_restrictions, ...)
# the result json should look like this:
# {
# "Node_Property_Restrictions": [
# {
# "Risk": "MEDIUM",
# "Place": "URBAN"
# },
# {
# "Risk": "LOW",
# "Place": "RURAL"
# }
# ]
# }

```
the resulting json should look like this:
```
{
"Node_Property_Restrictions": [
{
"Risk": "MEDIUM",
"Place": "URBAN"
},
{
"Risk": "LOW",
"Place": "RURAL"
}
]
}
```
"""
def __init__(self, individual_property_restrictions: List[List[str]] = None,
node_property_restrictions: List[List[str]] = None):
Expand Down Expand Up @@ -443,23 +454,23 @@ def _set_property_restrictions(self, campaign_object: s2c.ReadOnlyDict):
A function that configure the Property_Restrictions_Within_Node and Node_Property_Restrictions
for the campaign_object. This function is a private function that is used by the coordinator class and should
not be called directly by user code.

Args:
campaign_object: An EventCoordinator or Intervention object.

Returns:
This function does not return any value; instead, it modifies the campaign_object.

"""
def parse_to_dict(list_of_lists):
"""
A helper function that parse the list of lists to a list of dictionaries of key-value-pairs where each dict
can only contain a given key once.

Args:
list_of_lists:

Returns:
list of dictionaries of key-value-pairs where each dict can only contain a given key once.

"""
result = []
for inner_list in list_of_lists:
Expand Down Expand Up @@ -508,7 +519,6 @@ class ValueMap:
values (List[float]):
- A list of values that correspond to the times.
- The list of values should have the same length as times.

"""
def __init__(self, times: List[float], values: List[float]):
if not isinstance(times, list) or not isinstance(values, list):
Expand Down
10 changes: 4 additions & 6 deletions emodpy/campaign/distributor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,8 @@ def add_intervention_scheduled(campaign: api_campaign,
- Please refer to the emodpy.utils.targeting_config module for more information.
- If None (default), then there is not extra targeting.

Returns:
None, add the configuration to the campaign.

Examples:
```
from emodpy.campaign.distributor import add_intervention_scheduled
from emodpy.campaign.common import TargetDemographicsConfig, RepetitionConfig, PropertyRestrictions, TargetGender
from emodpy.campaign.individual_intervention import BroadcastEvent, OutbreakIndividual
Expand Down Expand Up @@ -121,6 +119,7 @@ def add_intervention_scheduled(campaign: api_campaign,
# Add a uniform delay (from 0 to 365 days) before the actual intervention is distributed
delay_distribution=uniform_distribution
)
```
"""
# Create a DelayedIntervention with the intervention if a delay_distribution is provided
intervention_list = _add_delay(campaign, delay_distribution, intervention_list)
Expand Down Expand Up @@ -216,6 +215,7 @@ def add_intervention_triggered(campaign: api_campaign,
- If None (default), then there is not extra targeting.

Examples:
```
from emodpy.campaign.distributor import add_intervention_triggered
from emodpy.campaign.common import TargetDemographicsConfig, RepetitionConfig, PropertyRestrictions, TargetGender
from emodpy.campaign.individual_intervention import BroadcastEvent, OutbreakIndividual
Expand Down Expand Up @@ -253,9 +253,7 @@ def add_intervention_triggered(campaign: api_campaign,
property_restrictions=PropertyRestrictions(individual_property_restrictions=[["Risk:High"]])
targeting_config=is_not_pregnant
)

Returns:
None, add the configuration to the campaign.
```
"""
# Create a DelayedIntervention with the intervention if a delay_distribution is provided
intervention_list = _add_delay(campaign, delay_distribution, intervention_list)
Expand Down
Loading