diff --git a/.github/workflows/ci-checks.yml b/.github/workflows/ci-checks.yml index 488e98dca..24f766d5c 100644 --- a/.github/workflows/ci-checks.yml +++ b/.github/workflows/ci-checks.yml @@ -18,6 +18,8 @@ jobs: files: . config_file: .markdownlint.yml + + py_formatting: runs-on: ubuntu-latest steps: diff --git a/0_domain_study/README.md b/0_domain_study/README.md index 308b71113..80cfcb4b4 100644 --- a/0_domain_study/README.md +++ b/0_domain_study/README.md @@ -1 +1,117 @@ # Domain Research + +## Research Question Table + +### Research Question 1 (Alona) + +**Research Question:** +How are the frequency and size of wildfires in North America related +to health problems caused by air pollution? + +**Research Novelty:** +Not really new + + + +**Expected Data Availability:** +Quite available + +**Problems:** +Although there is a lot of data, the topic is not really new and +doesn't seem very promising + +**Sources or Brief Explanation:** +Studies on PM2.5 in the US + + + + +--- + +### Research Question 2 (Alona) + +**Research Question:** +How are income level and the source of antibiotic prescriptions +related in Ukraine? + +**Research Novelty:** +Seems to be quite new + + + +**Expected Data Availability:** +We might get some data from government statistics or surveys, +but haven't checked yet + +**Problems:** +Prescription and purchase data may be incomplete or unofficial + +**Sources or Brief Explanation:** +WHO and UNICEF reports + +--- + +### Research Question 3 (Alona) + +**Research Question:** +How does the intensity of shelling in residential areas of Ukraine +affect access to and quality of online education? + +**Research Novelty:** +Very high + +**Expected Data Availability:** +Damage data: +[ACLED report on Russian targeting in Ukraine](https://acleddata.com/2025/02/21/bombing-into-submission-russian-targeting-of-civilians-and-infrastructure-in-ukraine/) + +Education data: Kolibri, Coursera for Refugees, UNICEF + +**Problems:** +Educational data is tricky to get. We should ask some big platforms +and wait a long time. They don’t usually specify regions in Ukraine. + +**Sources or Brief Explanation:** +UNICEF and UN reports + +--- + +### Research Question 4 (Alona) + +**Research Question:** +How does the availability of a well-developed public transportation +system influence processed food consumption in car-free households in Canada? + +**Research Novelty:** +High – haven’t found an exact match in literature + +**Expected Data Availability:** +Not sure + +**Problems:** +Very area-specific. Requires filtering by income level, car ownership, +and food type + +**Sources or Brief Explanation:** +_(Not specified)_ + +--- + +### Research Question 5 (Alona) + +**Research Question:** +How does non-prescription antibiotic use affect the spread of +antibiotic-resistant infections in Ukraine? + +**Research Novelty:** +Haven’t seen studies on this for Ukraine + +**Expected Data Availability:** +Some lab data from universities or public health sources. +Survey/pharmacy data limited + +**Problems:** +Black market access to antibiotics; unclear where we can +get microbiological data + +**Sources or Brief Explanation:** +WHO AMR reports diff --git a/Exploring_Kittens.png b/Exploring_Kittens.png new file mode 100644 index 000000000..e63451a9e Binary files /dev/null and b/Exploring_Kittens.png differ diff --git a/README.md b/README.md index e69de29bb..4337f5c5b 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,36 @@ +# Collaboration + +## Group Norms Summary + +Just like the game it is based on (Exploding Kittens), Exploring Kittens +is a fun-loving group of researchers who want to explore the world. +Our goal is to help each other, learn from one another, and grow together +as we explore the world of Computer and Data science. + +## Group Agreements (Intention-Based) + +- Open and respectful communication between members. Voices are not equally +loud but they are equally important. +- Consistent collaboration. We expect members to regularly participate and +contribute to the group. +We will however also be understanding if a member +needs some time off due to personal or professional commitments. +- Punctuality. We should expect to wait no more than 5 minutes for meetings +to start and people to be present. +- Curiosity. We all come from different backgrounds and places, +the only bad questions we can ask are questions that have been answered. +- Togetherness. Our group members are supportive of one another's needs, feelings +or circumstances. No one in the group is alone. +- Adaptibility. We are more focused on identifying solutions rather than +complaining about the problems or pointing fingers. We will be quick to change +our approach or methodology if need be. +- Respect. We are all human, we are all equal. We intend to value everyone's +time, commitments, and resources just like we value our own. +- Humor. Jokes are encouraged, we will strive to keep the atmosphere light +and refreshing so that meetings don't feel like a drag. +- Communication. We don't expect members to reply in real time, but +a response to messages or questions should have a reply in a day, +no more than 2 if the member is busy. +- Exploding Kittens. We will one day all play a game of Exploding Kittens +together. +![Alt text](Exploring_Kittens.png) diff --git a/collaboration/README.md b/collaboration/README.md deleted file mode 100644 index 20889b951..000000000 --- a/collaboration/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Collaboration - - - - diff --git a/collaboration/communication.md b/collaboration/communication.md index f9e2d0181..de6a5022f 100644 --- a/collaboration/communication.md +++ b/collaboration/communication.md @@ -15,32 +15,37 @@ | Day | How | The topic of discussion | | :----: | :-: | ----------------------: | -| | | | +| June 2nd | Google Meet | Respecting deadlines, collaboration | ## Communication Channels How often we will get in touch on each channel, and what we will discuss there: -- **Issues**: -- **Pull Requests**: -- **Slack/Discord**: -- **Video Calls**: +- **Issues**: To be discussed +- **Pull Requests**: Every day +- **Slack/Discord**: Every day +- **Video Calls**: Every 3 days ## Availability ### Availability for calling/messaging -| Day | Mon | Tue | Wed | Thu | Fri | Sat | Sun | -|--------|:---:|:---:|:---:|:---:|:---:|:---:|:---:| -| _name_ | | | | | | | | +| Day | Mon | Tue | Wed | Thu | Fri | Sat | Sun| +|-------|:-----:|:------:|:------:|:------:|:-----:|:---:|:----:| +| Alona |5–8 PM | 5–8 PM | 3–8 PM | 5–8 PM | 5–8 PM| No |9–8 PM EST| +| Asia |5–10 PM| 5–10 PM| 5–10 PM| 5–10 PM| No | 5–10 PM| 5–10 PM | +| Vahab |10–14 *| 10–14 *| 10–14 *| 10–14 *| 10–14 *| Can't plan in advanced|| +| Zaid| 7 PM-11 AM EST|7 PM-10 AM EST|7 PM-8 AM EST|7 PM-8 AM EST|No|No|No| + +\* Subject to change depending on other commitments. +Currently based in **Canada (Edmonton Time Zone - MST/MDT)**. +In **June**, located in **Central European Time Zone (CET/CEST)**. ### How many hours everyone has per day -- name: _5h_ -- name: _6h_ -- name: _5h_ -- name: _4h_ -- name: _3h_ +- Alona: _3h_ +- Vahab: _4h_ weekdays. +- Zaid: _3h_ ## Asking for Help diff --git a/collaboration/constraints.md b/collaboration/constraints.md index 24079505c..905fc0724 100644 --- a/collaboration/constraints.md +++ b/collaboration/constraints.md @@ -15,6 +15,14 @@ Some boundaries around our project. - ... --> +- *Deadlines Set by MIT-ET* + The schedule and priorities of the project are largely influenced by + deadlines established by MIT-ET. + +- *Organizational Requirements* + MIT-ET enforces specific tools, workflows, and approval processes that + the team must adhere to. + ## Internal: Involuntary +- *Differences in Skill Levels* + Team members have varying levels of experience in Python, programming, and + collaboration tools, requiring additional time for knowledge sharing and + onboarding. + +- *Limited Availability* + Some members manage full-time jobs or family responsibilities, + reducing their availability for meetings, reviews, or coding sessions. + +- *Unexpected Disruptions* + Personal issues or emergencies may occasionally hinder + participation or delay deliverables. + +- *Workload Imbalance* + Uneven contribution may occur, with some members needing to take on + extra tasks due to others' limited availability. + ## Internal: Voluntary + +- *Agreed-Upon Coding Standards* + The team has chosen to follow consistent coding conventions + to improve readability and maintainability. + +- *Standardized Git Workflow* + A version control strategy recommended by MIT-ET has been + adopted to ensure consistency and traceability. + +- *Task Prioritization Approach* + The group aligns on priorities, sets milestones, and commits + to internal deadlines. + +- *Commit Message Format* + Members use a unified format for commit messages + to maintain clarity and track changes effectively. + +- *Mandatory Peer Code Reviews* + All pull requests must be reviewed and approved by at least + one or two members before merging into the main branch. diff --git a/collaboration/learning_goals.md b/collaboration/learning_goals.md index 11c583d2b..68adfbf1d 100644 --- a/collaboration/learning_goals.md +++ b/collaboration/learning_goals.md @@ -2,4 +2,40 @@ ## Collective +- Learn how to find, analyze, and critically assess academic +research and other credible sources. +- Use previously acquired statistical knowledge to + analyze data and build real models. +- Learn to accurately define research problems and +design appropriate methodologies to address them. + ## Individual + +### Alona + +- Understand and learn the collaboration work process while + working on the group project in GitHub +- Gain experience in reviewing others' work and + contributing to open-source projects confidently. +- Improve collaboration skills by participating in group + projects, sharing ideas clearly, and communicating with the team. + +### Asia + +- I can improve my GitHub skills. +- Managing my time to meet deadlines. +- Gaining more knowledge and confidence dealing with different people. + +### Vahab + +- Understand how to use real-world data to define problems and uncover insights. +- Practice building models that help explain or solve real-world issues. +- Learn to use Jupiter Notebooks effectively for data exploration and modeling. +- Gain confidence in documenting, sharing, and communicating data science work clearly. + +### Zaid + +- Refresh my GitHub and Python skills. +- Learn something new. +- Improve my teamwork abilities. +- Gain experience working with vastly different time zones. diff --git a/collaboration/meeting_agenda.md b/collaboration/meeting_agenda.md new file mode 100644 index 000000000..053f11c1a --- /dev/null +++ b/collaboration/meeting_agenda.md @@ -0,0 +1,94 @@ + +# Meetings agenda + +--- + +## Communication Schedule + +| Day | How | The topic of discussion | +| :----: | :-: | ----------------------: | +| June 2nd | Google Meet | Respecting deadlines, collaboration | +| June 6th | Google Meet | Brainstorming questions | +| June 11th | Google Meet | Presenting questions and choosing one | +| June 15th| Google Meet | Finalising group research topic | + +## Content of each meeting + +### June 6th, 2 PM + +- How to define a question + - Be very specific + - Expect your question to change while doing more research +- Domain of interest of group members +- Choosing the right research question + - Keep availability of data in mind +- Ideas to use image analysis + - Explored applying image analysis in research domains like: + - Deforestation + - Biology + - Healthcare +- Consider difficulty of research question when proposing + - Too easy > Too difficult +- Elaborate on image analysis + +**_What to prepare for the next meeting?_** + +- On Wednesday, come to the meeting with one or more research questions +- Investigate whether image analysis is feasible or too difficult + +### June 11th, 5PM EST + +#### Key Discussion Points + +##### Proposed Research Questions + +1. How can online access to education support learning continuity during +pandemics and humanitarian crises such as refugee displacement? +2. What is the impact of wildfire exposure on respiratory health in Canada, + and how can it be quantified? +3. To what extent can the use of antidepressants and economic indicators in +small economies reflect the overall happiness and mental well-being of a population? +4. Can natural language processing (NLP) techniques be used to classify judicial +decisions as punitive or restorative based on the language in court judgments? +5. How effective is image analysis in detecting early signs of deforestation as +an indicator of climate change? + - Use vegetation index to train model. + - Many free images over several years are available online (1984–today). + - Recommended dataset: Global Forest Watch (2000–present). + - Consider region-bound analysis. + - Optionally incorporate air quality data from WorldAQ (e.g., CO₂ spikes as indicators). + +##### Platform Migration + +It was agreed that all ongoing chats and discussions will move to _Slack_ to +ensure better tracking and visibility for the MIT team. + +##### Next Steps + +- A follow-up meeting is scheduled for tomorrow to finalize the research topic. +- _Asia_ suggested that each member brings at least one research topic idea +to the next meeting. +- The group will then brainstorm collectively to narrow the suggestions down to +a concise, group-approved research focus. + +### June 15th, 5PM EST + +#### Review of Identified Group Research Topic + +- Final confirmation of the selected research topic; "How effective is Satellite +Image Analysis at Predicting Deforestation in Malaysia?" +- Clarification of objectives and scope + +#### Distributed Group Work + +- Task allocation and responsibilities +- Timeline and milestones leading up to **June 16** deadline + +#### Planning for the Next Meeting + +- Agreed on next meeting date, June 16th, 2025. + +#### Collaboration Folder Setup + +- All members are encouraged to complete their tasks in the collaborations +folder as soon as possible. diff --git a/collaboration/retrospective.md b/collaboration/retrospective.md deleted file mode 100644 index c24b796a7..000000000 --- a/collaboration/retrospective.md +++ /dev/null @@ -1,31 +0,0 @@ - - -# Retrospective - -## Stop Doing - -## Continue Doing - -## Start Doing - -## Lessons Learned - ---- - -## Strategy vs. Board - -### What parts of your plan went as expected? - -### What parts of your plan did not work out? - -### Did you need to add things that weren't in your strategy? - -### Or remove extra steps? - ---- - -## Individual Rerospectives - -### Name - - diff --git a/collaboration/retrospective_milestone1.md b/collaboration/retrospective_milestone1.md new file mode 100644 index 000000000..6207ba1f8 --- /dev/null +++ b/collaboration/retrospective_milestone1.md @@ -0,0 +1,76 @@ +# Retrospective Milestone 1 + +## Stop Doing + +- Not consistently documenting tasks and discussions on the project board. +- Joining meetings without sufficient preparation. +- Strictly enforcing the 80-character line limit in CI checks + +## Continue Doing + +- Doing an excellent job brainstorming ideas and questions, supporting +each other and actively discussing one another’s topics, helping +verify research novelty and suggesting additional ideas. +- Holding meetings regularly despite significant time zone +differences. +- Helping each other with GitHub setup and efficiently distributed tasks +among the active team members. + +## Start Doing + +- Using the group project board. +- Start organizing the workflow from the very beginning of the project. +- Better configure pull request policy + +## Lessons Learned + +- Sharing useful resources, including free datasets, among team members. +- Discussing topics like image analysis and antibiotics misuse to explore +different domains. +- Taking into account the different time zones of each team member is +important when planning meetings and deadlines. + +--- + +## Strategy vs. Board + +### What parts of your plan went as expected? + +- Excellent team work of active participants as well as excellent asynchronous work + +### What parts of your plan did not work out? + +- While generating many interesting research questions across domains, we +experienced delays in choosing a focus area — next time, we’ll aim for a +more time-efficient and organized selection process. + +### Did you need to add things that weren't in your strategy? + +- There are varying levels of engagement, with some members missing live +meetings and recordings + +--- + +## Individual Retrospectives + +### Alona + +- Did a great job with divergent thinking and came up with several + original research questions. +- Actively participated in organizing the team’s work and discussing + other group members’ questions. +- Made progress in convergent thinking. +- Still needs to improve the skill of conducting preliminary +research before formulating a question. +- Returned Bernard the cat to its owners + +### Cyne + +- Due to time zone differences, I was unable to attend most team meetings, +which limited my ability to participate in synchronous discussions. +- I am currently managing some personal challenges, which have affected +my ability to contribute as fully as I intended during this milestone. +- Despite this, I’ve been keeping up with the project’s progress and am +looking forward to contributing more consistently in the next phase. +- I appreciate my team’s flexibility and support, and I plan to better coordinate +my availability and communication for upcoming milestones. diff --git a/collaboration/retrospective_milestone_0.md b/collaboration/retrospective_milestone_0.md new file mode 100644 index 000000000..e6a5d2914 --- /dev/null +++ b/collaboration/retrospective_milestone_0.md @@ -0,0 +1,70 @@ +# Retrospective milestone 0 + +## Stop Doing + +- Letting tasks and discussions remain informal without proper + documentation on the project board. +- Wasting time revisiting issues that could have been + prevented through more structured workflows. + +## Continue Doing + +- Maintaining clear and effective communication via the WhatsApp group. +- Holding productive group and one-on-one meetings through Google Meet. +- Actively sharing knowledge and resources to minimize + information gaps within the team. + +## Start Doing + +- Encouraging full participation from all members in both + discussions and task execution. +- Scheduling regular review sessions to stay aligned with project goals. + +## Lessons Learned + +- Strong and consistent group communication is crucial to project success. +- Clearly defined roles and responsibilities lead to better accountability. +- Completing tasks ahead of deadlines allows time for reviews, + feedback, and revisions. +- Retrospectives can be used to break down complex challenges, +giving everyone the opportunity to contribute, learn, +and gain confidence in solving similar problems in the future. + +--- + +## Strategy vs. Board + +### What parts of your plan went as expected? + +- Clear communication channels, such as WhatsApp and Google + Meetings, worked well for collaboration. + +### What parts of your plan did not work out? + +- Group meetings were not reflected on the project board. + +### Did you need to add things that weren't in your strategy? + +- Some group members did not respond, which caused delays + and negatively affected collaboration. + +--- + +## Individual Retrospectives + +### Alona + +- Good organizational work was done. +- Collaborated willingly with other members. +- There are opportunities for growth in time management. + +### Asia + +- I can improve my GitHub skills. +- Collaboration on tasks saved us a lot of time + +### Zaid + +- Definitely needed the GitHub refresher. +- Timezones are a challenge, but if everyone is willing to compromise, +it can be overcome.