Skip to content

Commit 8f14969

Browse files
Merge pull request #1001 from kabilar/master
Update README
2 parents c3919cf + b40a94f commit 8f14969

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@
88
# Welcome to DataJoint for Python!
99
DataJoint for Python is a framework for scientific workflow management based on relational principles. DataJoint is built on the foundation of the relational data model and prescribes a consistent method for organizing, populating, computing, and querying data.
1010

11-
DataJoint was initially developed in 2009 by Dimitri Yatsenko in Andreas Tolias' Lab 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.
12-
13-
Vathes LLC supports DataJoint for Python as an open-source project and everyone is welcome to contribute.
14-
Its DataJoint Neuro (https://djneuro.io) business provides support to neuroscience labs for developing and executing custom data pipelines.
11+
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.
12+
Presently, the primary developer of DataJoint open-source software is the company DataJoint (https://datajoint.com). Related resources are listed at https://datajoint.org
1513

1614
## Installation
1715
```
@@ -22,7 +20,18 @@ If you already have an older version of DataJoint installed using `pip`, upgrade
2220
```bash
2321
pip3 install --upgrade datajoint
2422
```
23+
24+
## Documentation and Tutorials
25+
26+
* https://datajoint.org -- start page
27+
* https://docs.datajoint.org -- up-to-date documentation
28+
* https://tutorials.datajoint.io -- step-by-step tutorials
29+
* https://elements.datajoint.org -- catalog of example pipelines
30+
* https://codebook.datajoint.io -- interactive online tutorials
31+
2532
## Python Native Blobs
33+
<details>
34+
<summary>Click to expand details</summary>
2635

2736
DataJoint 0.12 adds full support for all native python data types in blobs: tuples, lists, sets, dicts, strings, bytes, `None`, and all their recursive combinations.
2837
The new blobs are a superset of the old functionality and are fully backward compatible.
@@ -92,16 +101,11 @@ the situation, but generally the following strategies may apply:
92101
As always, be sure that your data is safely backed up before modifying any
93102
important DataJoint schema or records.
94103

95-
## Documentation and Tutorials
96-
A number of labs are currently adopting DataJoint and we are quickly getting the documentation in shape in February 2017.
97-
98-
* https://datajoint.io -- start page
99-
* https://docs.datajoint.io -- up-to-date documentation
100-
* https://tutorials.datajoint.io -- step-by-step tutorials
101-
* https://catalog.datajoint.io -- catalog of example pipelines
104+
</details>
102105

103106
## Running Tests Locally
104-
107+
<details>
108+
<summary>Click to expand details</summary>
105109

106110
* Create an `.env` with desired development environment values e.g.
107111
``` sh
@@ -136,9 +140,9 @@ GID=1000
136140
* Add entry in `/etc/hosts` for `127.0.0.1 fakeservices.datajoint.io`
137141

138142

139-
140-
141143
### Launch Jupyter Notebook for Interactive Use
142144
* Navigate to `localhost:8888`
143145
* Input Jupyter password
144146
* Launch a notebook i.e. `New > Python 3`
147+
148+
</details>

0 commit comments

Comments
 (0)