🔵 Workflow 2.3: Read and Understand the Project¶

Phase 3. Read and understand the tools and techniques used in the project.

Professional Practice¶

Before modifying a project, first read and understand how it works.

Professional developers often explore a project in a consistent order: documentation, code, data, and outputs.

Focus on the overall flow of the project. It's not necessary to understand every line of code at this point.

Real-world projects contain many files, so most professional projects follow a predictable organization.

When referring to a folder in documentation, a / is often added to the name. For example, data/.

The slash is not part of the folder name - it just indicates a folder.

By the end of this phase you should understand:

Jupyter notebooks usually run from top to bottom.

Python modules are typically stored in src/. Execution often begins at an entry point near the end of the file:

def main():
    # This is where execution logic begins

if __name__ == "__main__":
    main()

When reading a Python file: