Skip to content

Commit 42804e9

Browse files
Merge pull request #413 from datajoint/stage
Update README
2 parents 18dfb18 + 324f7ed commit 42804e9

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ win.*
1010
macos.*
1111
*.prj
1212
*.mltbx
13-
Jobs.m
13+
Jobs.m
14+
.DS_Store

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
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

3+
# Welcome to DataJoint for MATLAB!
34
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.
45

5-
DataJoint was initially developed in 2009 by Dimitri Yatsenko in [Andreas Tolias' Lab](http://toliaslab.org) 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.
6-
6+
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.
7+
Presently, the primary developer of DataJoint open-source software is the company DataJoint (https://datajoint.com). Related resources are listed at https://datajoint.org.
78

89
## Installation
10+
<details>
11+
<summary>Click to expand details</summary>
912

1013
### (Recommended) Greater than R2016b
1114

@@ -35,10 +38,29 @@ DataJoint was initially developed in 2009 by Dimitri Yatsenko in [Andreas Tolias
3538
3. Right-Click and Select *Install*
3639
4. Select *Install*
3740

41+
</details>
42+
3843
## Config
3944
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.
4045

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+
54+
## Citation
55+
+ If your work uses DataJoint for MATLAB, please cite the following Research Resource Identifier (RRID) and manuscript.
56+
57+
+ DataJoint ([RRID:SCR_014543](https://scicrunch.org/resolver/SCR_014543)) - DataJoint for MATLAB (version `<Enter version number>`)
58+
59+
+ Yatsenko D, Reimer J, Ecker AS, Walker EY, Sinz F, Berens P, Hoenselaar A, Cotton RJ, Siapas AS, Tolias AS. DataJoint: managing big scientific data using MATLAB or Python. bioRxiv. 2015 Jan 1:031658. doi: https://doi.org/10.1101/031658
60+
4161
## Running Tests Locally
62+
<details>
63+
<summary>Click to expand details</summary>
4264

4365
* Create an `.env` with desired development environment values e.g.
4466
``` sh
@@ -82,3 +104,5 @@ MINIO_VER=RELEASE.2022-01-03T18-22-58Z
82104

83105
* Shell into `datajoint-matlab_app_1` i.e. `docker exec -it datajoint-matlab_app_1 bash`
84106
* Launch Matlab with no GUI by runnning command `matlab -nodisplay`
107+
108+
</details>

0 commit comments

Comments
 (0)