The goal of this project is to develop a tool that integrates trees into 3D urban models to improve the efficiency of thermal simulations. This project is part of the HiDALGO2 initiative, which aims to explore synergies between modeling, data acquisition, simulation, data analysis and visualization, with focus on improving building energy efficiency and indoor air quality.
Installation and Usage
Required Packages
To build the project, you either need the following packages or you can use the provided Docker container:
Task: Analyze and document the first results obtained from the project's initial research and development activities. Highlight significant findings and any unexpected outcomes.
Requirements:
Gather all results and data collected to date.
Perform a preliminary analysis to identify trends, insights, or anomalies.
Discuss the findings with the project team to gain additional perspectives.
Note any areas where results deviate from initial expectations and possible reasons.
Deliverables:
A report summarizing the first results, including data visualizations or charts as appropriate.
Recommendations for next steps based on these initial findings.
Task: Evaluate and improve the tools and practices used by the project team to collaborate more effectively. Consider incorporating new tools or refining existing processes to enhance teamwork and communication.
Requirements:
Review current collaboration tools and methods.
Gather feedback from the team on effectiveness and areas for improvement.
Research potential tools or practices that could enhance collaboration.
Deliverables:
A report on current collaboration practices with proposed enhancements.
Implementation plan for any new tools or processes adopted.
Task: Ensure that all aspects of the project are well-documented, including code, user guides, and technical specifications. Aim to make documentation accessible and useful for both the team and external contributors.
Requirements:
Audit existing documentation for completeness and accessibility.
Identify gaps in documentation and areas needing updates.
Develop templates or guidelines for consistent documentation.
Deliverables:
A documentation improvement plan, detailing areas of focus and timelines.
Updated or new documentation as identified in the plan.
Task: Perform a thorough review of the project’s codebase and technical outputs to ensure high quality and maintainability. Identify areas for refactoring or improvement.
Requirements:
Organize a code review session with the development team.
Use static analysis tools to identify code quality issues.
Document findings and prioritize refactoring tasks.
Deliverables:
Code review report, highlighting areas of concern and suggested improvements.
A roadmap for addressing technical debt and enhancing code quality.
Task: Write the final project report detailing the project's context, objectives, methodologies, results, and conclusions. The report should provide a clear and thorough account of the project from inception to conclusion, including a roadmap of the project's development, challenges faced, solutions implemented, and lessons learned.
Requirements:
Introduction and background of the project.
Detailed descriptions of the project phases and milestones.
Analysis of the results and their implications.
Reflection on the project's successes and areas for improvement.
Integration of the consolidated bibliography.
Deliverables:
A final report document in .pdf format(written using latex), of 30 pages maximum.
Peer reviews from at least two team members before submission.
Task: Update the project roadmap and milestones based on the achievements of the first iteration and the refined project scope. Ensure the roadmap reflects realistic timelines and priorities.
Requirements:
Review the initial roadmap and milestones in the context of V1 progress.
Adjust timelines and priorities as necessary to align with updated project scope and objectives.
Communicate updates to the team and stakeholders to ensure alignment.
Deliverables:
An updated project roadmap with revised milestones.
A presentation or document summarizing key changes to the roadmap and the reasons behind them.
Task: Create the final presentation for the project, covering all major milestones, key findings, challenges overcome, and future directions. Ensure the presentation is engaging, well-structured, and adequately reflects the work done throughout the project.
Requirements:
Include all team members in the preparation and presentation process.
Use clear and concise slides with relevant data and visuals.
Practice the presentation multiple times as a team.
Prepare to answer questions regarding the project specifics and decisions made.
Deliverables:
A Latex/PDF Slides presentation file.
A script or notes for each slide to assist with the presentation.
Task: Expand and refine the project bibliography to include any new sources consulted during the first iteration. Ensure all references are accurately cited and formatted.
Requirements:
Compile all new sources of information or data used since the last iteration.
Check each source for proper citation format and completeness.
Organize the bibliography to be clear and easily navigable.
Deliverables:
An updated bibliography file with all new sources included.
A list highlighting key sources added in V1 and their relevance to the project.
Task: Based on the first iteration’s insights and outcomes, refine the project scope and clarify deliverables for the next phase. Ensure alignment with project objectives and stakeholder expectations.
Requirements:
Reassess the initial project scope in light of V1 results.
Identify any necessary adjustments to project deliverables.
Update scope documents and communicate changes to all stakeholders.
Deliverables:
Updated project scope document.
Revised list of project deliverables for the next phase, with rationale for any changes.
Task: Update the README file to ensure it is comprehensive, clear, and up-to-date. The README should effectively introduce the project and guide new users and contributors.
Requirements:
Include a concise project title and description.
Provide clear installation instructions.
Detail usage examples or guides.
Specify contribution guidelines.
State the license information if relevant.
Acknowledge contributors and provide credits where necessary.
List features, possible roadmap, and current project status.
Explain how to run tests.
Address frequently asked questions or common issues.
Provide contact information for further inquiries.
Deliverables:
An updated README.adoc or README.md file that covers all the above sections effectively.
Updated documentation files if applicable.
Please ensure the README is formatted properly and is easy to read. Use Asciidoc or Markdown formatting to enhance readability and structure.
Task: Review and update the project objectives and sub-objectives based on the first month's progress and insights. Ensure the objectives are aligned with the current project direction and any new challenges identified.
Requirements:
Assess the initial objectives against current project status.
Adjust objectives to incorporate new findings or shifts in project focus.
Clearly document any changes to objectives or sub-objectives.
Discuss potential impacts of these changes with the project team.
Deliverables:
An updated objectives document highlighting any changes made for V1 iteration.
A brief presentation to the project team outlining the objective updates and rationale behind them.
Task: Review and consolidate all references and sources used throughout the project into a single, organized bibliography. Ensure that all sources are correctly cited and formatted according to [specific citation style - e.g., APA, MLA, IEEE].
Requirements:
Collect all sources used by each team member.
Check each citation for accuracy and completeness.
Organize the bibliography in alphabetical order or according to the citation style’s requirements.
Deliverables:
A final bibliography file in .bib format.
A list of any sources missing necessary information for follow-up.