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

Update for Sandbox (Adding Genesis for Distribution) #1786

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

c-yuwei
Copy link
Collaborator

@c-yuwei c-yuwei commented Jan 23, 2025

This PR introduces braph2genesis_lite, a function for generating a lite version of BRAPH-2 that includes only the elements an user specifies. The resulting output is a standalone, GUI-ready, and fully unit-tested piece of software that’s easy to distribute/develop—all while ensuring it retains the essential BRAPH-2 functionality an end user needs.

This PR illustrates the usage of braph2genesis_lite through three progressively more complex examples:

Hello-World

  • Demonstrates a simple pipeline where the user enters string A (e.g., “Hello”) and string B (e.g., “World”), and the software combines them into a single string (“Hello World!”).

  • Showcases the minimal overhead needed to create a fully compiled, self-contained application with a basic GUI and tests.

Selected Ready-Pipelines

  • Produces a focused BRAPH-2 distribution containing only a subset of existing pipelines from the repository, plus the classes they require.
  • Highlights how you can trim the codebase to exactly what’s needed, reducing size and complexity while keeping a fully functional tool.

User-Customized Pipelines

  • Incorporates entirely new or user-defined elements and pipelines, showing how developers can extend BRAPH-2 to suit their own requirements without pulling in every module of the main framework.
  • Emphasizes the flexibility of the genesis mechanism to adapt and compile new functionality on-the-fly.

Through these examples, this PR demonstrates how genesis enables users to create and distribute targeted BRAPH-2 builds—maintaining professional code standards, complete documentation, and robust testing while avoiding the overhead of the entire repository.

@c-yuwei c-yuwei changed the title Sandbox for lite genesis Sandbox for Lite Genesis Jan 23, 2025
@c-yuwei c-yuwei changed the title Sandbox for Lite Genesis Update for Sandbox (Adding Lite Genesis) Jan 23, 2025
@c-yuwei c-yuwei changed the title Update for Sandbox (Adding Lite Genesis) Update for Sandbox (Adding Genesis for Distribution) Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant