Skip to content

Commit 1c58ce2

Browse files
committed
WIP add docs
1 parent 42804e9 commit 1c58ce2

File tree

94 files changed

+1300
-1266
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+1300
-1266
lines changed

README.md

Lines changed: 3 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,17 @@
11
[![View DataJoint on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/63218-datajoint)
22

33
# Welcome to DataJoint for MATLAB!
4+
45
DataJoint for MATLAB is a high-level programming interface for relational databases designed to support data processing chains in science labs. DataJoint is built on the foundation of the relational data model and prescribes a consistent method for organizing, populating, and querying data.
56

67
DataJoint was initially developed in 2009 by Dimitri Yatsenko in Andreas Tolias' Lab at Baylor College of Medicine for the distributed processing and management of large volumes of data streaming from regular experiments. Starting in 2011, DataJoint has been available as an open-source project adopted by other labs and improved through contributions from several developers.
78
Presently, the primary developer of DataJoint open-source software is the company DataJoint (https://datajoint.com). Related resources are listed at https://datajoint.org.
89

9-
## Installation
10-
<details>
11-
<summary>Click to expand details</summary>
12-
13-
### (Recommended) Greater than R2016b
14-
15-
1. Utilize MATLAB built-in GUI i.e. *Top Ribbon -> Add-Ons -> Get Add-Ons*
16-
2. Search and Select `DataJoint`
17-
3. Select *Add from GitHub*
18-
19-
### Using GHToolbox (FileExchange Community Toolbox)
20-
21-
1. Install *GHToolbox* using using an appropriate method in https://github.com/datajoint/GHToolbox
22-
2. run: `ghtb.install('datajoint/datajoint-matlab')`
23-
24-
### Less than R2016b
25-
26-
1. Utilize MATLAB built-in GUI i.e. *Top Ribbon -> Add-Ons -> Get Add-Ons*
27-
2. Search and Select `DataJoint`
28-
3. Select *Download from GitHub*
29-
4. Save `DataJoint.mltbx` locally
30-
5. Navigate in MATLAB tree browser to saved toolbox file
31-
6. Right-Click and Select *Install*
32-
7. Select *Install*
33-
34-
### From Source
35-
36-
1. Download `DataJoint.mltbx` locally
37-
2. Navigate in MATLAB tree browser to saved toolbox file
38-
3. Right-Click and Select *Install*
39-
4. Select *Install*
40-
41-
</details>
10+
For more information, please visit our [documentation](https://datajoint.com/docs/core/datajoint-matlab/).
4211

4312
## Config
4413
For help in utilizing `dj.config` (added in `3.4.0`), you may access the help via `help('dj.config')` or review it online [here](https://github.com/datajoint/datajoint-matlab/blob/c2bd6b3e195dfeef773d4e12bad5573c461193b0/%2Bdj/config.m#L2-L27). Formal documentation to follow.
4514

46-
## Documentation and Tutorials
47-
48-
* https://datajoint.org -- start page
49-
* https://docs.datajoint.org -- up-to-date documentation
50-
* https://tutorials.datajoint.io -- step-by-step tutorials
51-
* https://elements.datajoint.org -- catalog of example pipelines
52-
* https://codebook.datajoint.io -- interactive online tutorials
53-
5415
## Citation
5516
+ If your work uses DataJoint for MATLAB, please cite the following Research Resource Identifier (RRID) and manuscript.
5617

@@ -105,4 +66,4 @@ MINIO_VER=RELEASE.2022-01-03T18-22-58Z
10566
* Shell into `datajoint-matlab_app_1` i.e. `docker exec -it datajoint-matlab_app_1 bash`
10667
* Launch Matlab with no GUI by runnning command `matlab -nodisplay`
10768

108-
</details>
69+
</details>

docs-parts/admin/5-blob-config_lang1.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs-parts/admin/5-blob-config_lang2.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs-parts/admin/5-blob-config_lang3.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs-parts/admin/5-blob-config_lang4.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs-parts/admin/5-blob-config_lang5.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs-parts/computation/01-autopopulate_lang1.rst

Lines changed: 0 additions & 23 deletions
This file was deleted.

docs-parts/computation/01-autopopulate_lang2.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs-parts/computation/01-autopopulate_lang3.rst

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs-parts/computation/01-autopopulate_lang4.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)