-
Notifications
You must be signed in to change notification settings - Fork 0
Add cheatsheet. #131
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
Add cheatsheet. #131
Changes from 4 commits
ef355ed
a1ed3d9
b739174
74dcade
522d516
0f2903f
503bf6e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| # 🌊 Ocean Protocol VS Code Extension — User Cheatsheet | ||
|
|
||
| Run **Compute-to-Data jobs** directly from VS Code. | ||
|
|
||
| --- | ||
|
|
||
| ## ✅ Requirements | ||
|
|
||
| - VS Code **v1.96.0 or higher** | ||
| - Algorithm file open (`.py` or `.js`) | ||
|
|
||
| --- | ||
|
|
||
| ## 📦 Installation | ||
|
|
||
| 1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/). | ||
|
||
| 2. Open the **Ocean Protocol** panel (left Activity Bar). | ||
| 3. Configure settings: | ||
| - **Node URL** (default provided) | ||
|
||
| - **Algorithm file** (mandatory provided) | ||
|
||
| - **Results folder** (mandatory provided) | ||
| - (Optional) Custom Docker image/tag | ||
|
||
| - (Optional) Dockerfile | ||
|
|
||
| --- | ||
|
|
||
| ## ▶️ Running a Compute Job | ||
|
|
||
| 1. Open an **algorithm file** (`.js` or `.py`). | ||
|
||
| 2. (Optional) Select: | ||
| - Dataset file | ||
| 3. Select **Results folder** | ||
| 4. In the **Ocean panel**, click **Start Compute Job**. | ||
| 5. Watch logs & job status in the **Output panel**. | ||
| 6. When finished, results file opens automatically in VS Code. | ||
|
||
|
|
||
| --- | ||
|
|
||
| ## ⚡ Tips | ||
|
|
||
| - **Free compute credits** available for dev/testing. | ||
|
||
| - Switch settings anytime in the **Ocean panel**. | ||
| - Logs & errors show up in the **Output** or **Terminal**. | ||
| - Supports both **Python** and **JavaScript** algorithms. | ||
| - The extension allows to import **Dockerfiles**, instead typing docker image and docker tag. | ||
|
|
||
| --- | ||
|
|
||
| ## 🛠️ Troubleshooting | ||
|
|
||
| - ❌ Job not running → check Node URL. | ||
giurgiur99 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - ❌ Compute environment fails → adjust Node URL. | ||
| - Always check **extension logs** in Output. | ||
|
|
||
| --- | ||
|
|
||
| ## 🔄 Workflow Summary | ||
|
|
||
| | Step | Action | | ||
| | ---- | -------------------------------------------- | | ||
| | 1 | Open algorithm file (`.py` or `.js`) | | ||
| | 2 | Configure node, output folder in Ocean panel | | ||
| | 3 | Click **Start Compute Job** | | ||
| | 4 | Monitor logs & job status | | ||
| | 5 | Results open automatically in VS Code | | ||
|
|
||
| --- | ||
|
|
||
| ## 📚 Resources | ||
|
|
||
| - [Ocean Protocol Docs](https://docs.oceanprotocol.com/developers/vscode) | ||
| - [GitHub Repo](https://github.com/oceanprotocol/vscode-extension) | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No longer needed, we switched to "New project"/"Select project" style