You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+56-26
Original file line number
Diff line number
Diff line change
@@ -1,39 +1,39 @@
1
1
# Ocean Protocol VSCode Extension
2
2
3
-
This VSCode extension enables you to execute compute-to-data jobs using Ocean Protocol directly from your development environment. The extension automatically detects your active algorithm file and streamlines job submission, monitoring, and results retrieval.
3
+
Run compute jobs on Ocean Protocol directly from VS Code. The extension automatically detects your active algorithm file and streamlines job submission, monitoring, and results retrieval. Simply open a python or javascript file and click **Start Compute Job**.
4
4
5
5
## Features
6
6
7
-
-**Compute-to-Data**: Run secure compute jobs without downloading raw data.
8
-
-**Active File Detection**: Automatically uses your open JavaScript (.js) or Python (.py) file as the compute algorithm.
9
-
-**Dataset & Results Integration**: Optionally select a dataset file and specify a results folder.
10
-
-**Job Monitoring**: View job status and algorithm logs in the output panel while results are automatically opened upon job completion.
7
+
### 🚀 One-Click Compute Jobs
11
8
12
-
## Prerequisites
9
+
Select your algorithm, choose a dataset, and run compute jobs with a single click.
13
10
14
-
- Node.js (version specified in `.nvmrc`)
15
-
- VSCode version 1.93.0 or higher
16
-
- Git
11
+
### 📊 Real-Time Monitoring
17
12
18
-
## Running the Extension Locally
13
+
Track job progress and view algorithm logs directly in VS Code.
- Press F5 to start debugging. This will open a new VSCode window with the extension loaded.
15
+
### 📁 Automatic Results Handling
16
+
17
+
Results are automatically saved and opened when your job completes.
35
18
36
-
## Usage
19
+
## Getting Started
20
+
21
+
1. Install the extension from the VS Code Marketplace
22
+
2. Open the Ocean Protocol panel from the activity bar
23
+
3. Configure your compute settings:
24
+
- Node URL (pre-filled with default Ocean compute node)
25
+
- Optional private key for your wallet
26
+
4. Select your files:
27
+
- Algorithm file (JS or Python)
28
+
- Optional dataset file (JSON)
29
+
- Results folder location
30
+
5. Click **Start Compute Job**
31
+
6. Monitor the job status and logs in the output panel
32
+
7. Once completed, the results file will automatically open in VSCode
33
+
34
+
### Requirements
35
+
36
+
VS Code 1.96.0 or higher
37
37
38
38
### Extension Layout
39
39
@@ -58,6 +58,36 @@ The extension adds a dedicated Ocean Protocol section to the activity bar. Here
58
58
59
59
Refer to the project structure and available scripts for local development. Contributions are always welcome—please check our guidelines in the repository.
0 commit comments