Skip to content

Commit 51382e4

Browse files
tsuchiyama-arayatsuchiyama-araya
authored
Merge pull request #660 from arayabrain/develop-main
barebone develop-main -> oist develop-main
2 parents 4b8cec6 + 1d785fc commit 51382e4

23 files changed

+336
-87
lines changed

‎docs/_static/other/maintenance_folder.png

25.4 KB
Loading

‎docs/_static/other/maintenance_popup.png

78.6 KB
Loading

‎docs/_static/other/snakemake_node_ready_first.png

33.5 KB
Loading

‎docs/_static/other/snakemake_node_ready_second.png

162 KB
Loading

‎docs/_static/other/snakemake_node_ready_third.png

55.1 KB
Loading

‎docs/_static/record/table.png

11.1 KB
Loading

‎docs/_static/workflow/create_new_workflow.png

-40.1 KB
Loading

‎docs/_static/workflow/filter_before.png

45.3 KB
Loading

‎docs/_static/workflow/filter_box.png

133 KB
Loading

‎docs/_static/workflow/filter_button.png

18.5 KB
Loading

‎docs/_static/workflow/imageList.png

796 Bytes
Loading

‎docs/_static/workflow/log_button.png

8.25 KB
Loading

‎docs/_static/workflow/log_viewer_sample.png

1.42 MB
Loading

‎docs/_static/workflow/whole.png

-52.2 KB
Loading

‎docs/for_developers/data_classes.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### DataClass
2+
3+
Optinist defines several data classes to ensure consistency between Input and Output types.
4+
5+
- OptiNiSt supports these input data classes:
6+
- ImageData
7+
- FluoData
8+
- BehaviorData
9+
- TimeSeriesData
10+
- Suite2pData
11+
- CaimanCnmfData
12+
- LccdData
13+
- IscellData
14+
- NWBFile
15+
- RoiData
16+
- SpikingActivityData,
17+
18+
- OptiNiSt supports these data visualisation classes:
19+
- BarData
20+
- HeatMapData,
21+
- HistogramData
22+
- ScatterData
23+
- LineData
24+
- PieData
25+
- PolarData
26+
- ScatterData

‎docs/for_developers/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ See the following guidelines before submitting Pull Requests.
1414
style
1515
pull_request
1616
test
17+
data_classes
1718
nwb_file

‎docs/gui_guide/record.md

+32-25
Original file line numberDiff line numberDiff line change
@@ -9,44 +9,48 @@ In the RECORD field, you can check the workflow status in your `OPTINIST_DIR` an
99
</p>
1010

1111
### Record Table
12+
1213
In RECORD table, you can:
14+
1315
- See past executed workflows
1416
- Reproduce past workflow
1517
- Download files
16-
- Workflow config file
17-
- Snakemake config file
18-
- Results as NWB files
18+
- Workflow config file
19+
- Snakemake config file
20+
- Results as NWB files
21+
- Copy workflow record
1922
- Delete workflow record
2023

2124
<p align="center">
2225
<img width="600px" src="../_static/record/table.png" alt="Record table"/>
2326
</p>
2427

25-
| Header | Description |
26-
| --- | --- |
27-
| Timestamp | Latest execution timestamp. <br>It shows start time, end time and elapsed time of the workflow. |
28-
| ID | Workflow's unique id. <br>This is same as the directory name for the whole results of the workflow. |
29-
| Name | User-defined workflow name. You can edit the name by clicking the name. |
30-
| Success | Workflow's status. Success, error or running. |
31-
| Reproduce | Button to reproduce the workflow to the WORKFLOW field. <br>You can visualize the results for the workflow by clicking the button. |
32-
| Workflow | Button to download the workflow config yaml file. <br>This file can be used on import workflow button on WORKFLOW tab. <br>See details in [](ImportWorkflowYaml). |
33-
| SnakeFile | Button to download the snakemake config file. |
34-
| NWB | Button to download the analysis results as NWB file. |
35-
| Delete | Button to delete the workflow record from the OPTINIST_DIR. |
28+
| Header | Description |
29+
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30+
| Timestamp | Latest execution timestamp. <br>It shows start time, end time and elapsed time of the workflow. |
31+
| ID | Workflow's unique id. <br>This is same as the directory name for the whole results of the workflow. |
32+
| Name | User-defined workflow name. You can edit the name by clicking the name. |
33+
| Success | Workflow's status. Success, error or running. |
34+
| Reproduce | Button to reproduce the workflow to the WORKFLOW field. <br>You can visualize the results for the workflow by clicking the button. |
35+
| Workflow | Button to download the workflow config yaml file. <br>This file can be used on import workflow button on WORKFLOW tab. <br>See details in [](ImportWorkflowYaml). |
36+
| SnakeFile | Button to download the snakemake config file. |
37+
| NWB | Button to download the analysis results as NWB file. |
38+
| Delete | Button to delete the workflow record from the OPTINIST_DIR. |
3639

3740
### Details
41+
3842
You can check the results of each node by clicking arrow icon on the left of the table.
3943

4044
<p align="center">
4145
<img width="600px" src="../_static/record/details.png" alt="Record detail"/>
4246
</p>
4347

44-
| Header | Description |
45-
| --- | --- |
46-
| Function | Name of the node. |
47-
| nodeID | Unique id of the node. <br>This is same as the directory name for the results of the node. <br> This id is shown on the each node's bottom. |
48-
| Success | Node's status. Success, error or running. |
49-
| NWB | Button to download the analysis results for the algorithm as NWB file. |
48+
| Header | Description |
49+
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
50+
| Function | Name of the node. |
51+
| nodeID | Unique id of the node. <br>This is same as the directory name for the results of the node. <br> This id is shown on the each node's bottom. |
52+
| Success | Node's status. Success, error or running. |
53+
| NWB | Button to download the analysis results for the algorithm as NWB file. |
5054

5155
If status is error, you can see the error message by clicking status icon.
5256

@@ -55,7 +59,9 @@ If status is error, you can see the error message by clicking status icon.
5559
</p>
5660

5761
(ReproduceButton)=
62+
5863
### Reproduce Button
64+
5965
Clicking the Reproduce arrow retrieves the pipeline onto the workflow.
6066

6167
This function is convenient when you want to check the results of the past workflow or reuse the same analysis pipeline.
@@ -72,6 +78,7 @@ This function is convenient when you want to check the results of the past workf
7278
```
7379

7480
(DownloadButtons)=
81+
7582
### Download Buttons
7683

7784
<br>
@@ -81,8 +88,8 @@ This function is convenient when you want to check the results of the past workf
8188

8289
You can download 3 types of config files here.
8390

84-
| FileType | Description |
85-
| --- | --- |
86-
| Workflow | It includes the workflow and parameters information to reproduce in OptiNiSt GUI. <br>This file can be used on import workflow button on WORKFLOW tab. <br>See details in [](ImportWorkflowYaml). |
87-
| SnakeFile | It includes the workflow and parameters information used by Snakemake. |
88-
| NWB | NWBfile which contains the data and its analysis results. |
91+
| FileType | Description |
92+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93+
| Workflow | It includes the workflow and parameters information to reproduce in OptiNiSt GUI. <br>This file can be used on import workflow button on WORKFLOW tab. <br>See details in [](ImportWorkflowYaml). |
94+
| SnakeFile | It includes the workflow and parameters information used by Snakemake. |
95+
| NWB | NWBfile which contains the data and its analysis results. |

0 commit comments

Comments
 (0)