Requirements
- Before installing Grapycal, make sure you have Python 3.11 installed. -Install
-
- Enter the following command to install Grapycal and its built-in extensions.
-
- pip install grapycal grapycal-builtin
-
Quick Start
-Enter the following command to start Grapycal.
-grapycal
- Then go to http://localhost:9001. Have fun! -
-Documentation -
--
-
- Getting Started -
- Contributing -
+ In our daily lives, countless ideas emerge in our minds, only to be dismissed because the + perceived cost of realizing them is too high. Over time, sadly, we tend to forget our inherent + creativity. +
++ The mission of Grapycal is to push more ideas over the line to be worthy of trying out. +
++ Grapycal is helpful for conducting experiments, including training AI, physical simulations, + data analysis, computer art, and more. These experiments require repeated parameter adjustments, + swapping certain components of models, while simultaneously observing the phenomena generated by + different parameters. We then use human judgment combined with domain knowledge to deduce the + best model or other conclusions. +
++ In this back-and-forth process between humans and machines, using traditional Python execution + methods or Jupyter notebooks can be cumbersome. Therefore, we need the higher interactivity + provided by Grapycal. +
+- Start by visiting - the Project Board to see what we are working on. Pick one and assign yourself to it. If you have a new idea, you can also create a new issue. -
-What you can do
--
-
- Add features or fix bugs to the backend. -
- Add features or fix bugs to the frontend. -
- Create a new extension for any domain you like (such as image processing or music - synthesis) by following tutorial. -
- Improve current extensions by adding new nodes or fixing bugs. Existing extensions are in - the extensions folder of the Grapycal repository. -
- Improve the documentation. -
- Improve the Website by modifying the source code: Main-Page. - -
- Create issues to report bugs or request features. -
- Leave comments on the Project Board with your thoughts to the existing plans. -
To start contributing
--
-
- Please install Grapycal from source. -
- Play around with Grapycal and feel how Grapycal helps you as a user. Find out what you like and what you don't like. If you feel something is missing, you can add it and create a pull request or open an issue. -
- Refer to the project overview to understand the project structure. -
- If you don't know where to start, visit the Project Board. - Find a topic that interests you and assign yourself to it. If you have a new idea, you can also create a new topic. -
To discuss with us, feel free to go to Discussion or join the Discord server.
-