Skip to content

Commit 8a8f71b

Browse files
committed
major update of files
1 parent fd1436d commit 8a8f71b

File tree

9 files changed

+146
-109
lines changed

9 files changed

+146
-109
lines changed

mkdocs.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ nav:
3737
- Open Ephys GUI: partnerships/openephysgui.md
3838
- Suite2p: partnerships/suite2p.md
3939
- About:
40+
- About: about/about.md
4041
- History: about/history.md
4142
- Team: about/datajoint-team.md
4243
- Citation Guidelines: about/citation.md

src/elements/concepts.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Concepts
22

3-
The following conventions describe the DataJoint Python API implementation.
3+
The following conventions describe the DataJoint Python API implementation.
44

55
## DataJoint Schemas
66

@@ -22,7 +22,7 @@ reference the database schema.
2222
corresponding _database schema_.
2323

2424
The module's `schema` object is then used as the decorator for classes that define
25-
tables in the database.
25+
tables in the database.
2626

2727
=== "Matlab"
2828

@@ -37,34 +37,32 @@ reference the database schema.
3737
An Element is a software package defining one or more DataJoint schemas serving a
3838
particular purpose. By convention, such packages are hosted in individual GitHub
3939
repositories. For example, Element `element_calcium_imaging` is hosted at
40-
[this GitHub repository](https://github.com/datajoint/element-calcium-imaging) and contains two DataJoint
41-
schemas: `scan` and `imaging`.
40+
[this GitHub repository](https://github.com/datajoint/element-calcium-imaging) and
41+
contains two DataJoint schemas: `scan` and `imaging`.
4242

4343
### YouTube Tutorials
4444

45-
The following YouTube videos provide information on basic design principles and file organization.
45+
The following YouTube videos provide information on basic design principles and file
46+
organization.
4647

4748
- [Why neuroscientists should use relational databases](https://www.youtube.com/watch?v=q-PMUSC5P5o)
4849
compared to traditional file hierarchies.
49-
- [Quickstart Guide](https://www.youtube.com/watch?v=5R-qnz37BKU) including
50-
terminology, and how to read DataJoint Diagrams and DataJoint Python table
51-
definitions.
50+
- [Quickstart Guide](https://www.youtube.com/watch?v=5R-qnz37BKU) including terminology,
51+
and how to read DataJoint Diagrams and DataJoint Python table definitions.
5252
- [Intro to the Element and Workflow files](https://www.youtube.com/watch?v=tat9MSjkH_U)
5353
for an overview of the respective GitHub repositories.
54-
- [Overview of upstream Elements](https://www.youtube.com/watch?v=NRqpKNoHEY0) to
55-
ingest and explore Lab, Animal, and Session metadata.
56-
57-
???+ Note
54+
- [Overview of upstream Elements](https://www.youtube.com/watch?v=NRqpKNoHEY0) to ingest
55+
and explore Lab, Animal, and Session metadata.
5856

5957
Some videos feature outdated versions of the respective GitHub repositories. For the
6058
most updated information, check the
6159
[documentation page](../) for the corresponding Element.
6260

6361
### Deferred schemas
6462

65-
A _deferred schema_ is one in which the name of the database schema name is not specified.
66-
This module does not declare schema and tables upon import.
67-
Instead, they are declared by calling `schema.activate('<schema_name>')` after import.
63+
A _deferred schema_ is one in which the name of the database schema name is not
64+
specified. This module does not declare schema and tables upon import. Instead, they are
65+
declared by calling `schema.activate('<schema_name>')` after import.
6866

6967
By convention, all modules corresponding to deferred schema must declare the function
7068
`activate` which in turn calls `schema.activate`.
@@ -90,9 +88,9 @@ in a `linking_module` and passed to the module's `activate` function. By keeping
9088
upstream requirements in the linking module, all Elements can be activated as part of
9189
any larger pipeline.
9290

93-
For instance, the
91+
For instance, the
9492
[Scan module](https://github.com/datajoint/element-calcium-imaging/blob/main/element_calcium_imaging/scan.py)
9593
receives its required functions from the linking module passed into the module's
96-
`activate` function. See the
97-
[example notebooks](https://github.com/datajoint/element-calcium-imaging/)
98-
for an example of how the linking module is passed into the Element's module.
94+
`activate` function. See the
95+
[example notebooks](https://github.com/datajoint/element-calcium-imaging/) for an
96+
example of how the linking module is passed into the Element's module.
Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,56 @@
11
# Quality Assurance
22

3-
DataJoint and DataJoint Elements serve as a framework and starting points for numerous
4-
new projects, setting the standard of quality for data architecture and software
5-
design. To ensure higher quality, the following policies have been adopted into the
6-
software development lifecycle (SDLC).
3+
DataJoint and DataJoint Elements serve as frameworks and starting points for numerous
4+
new projects, setting the standard for data architecture and software design quality. To
5+
ensure higher quality, the following policies have been adopted into the Software
6+
Development Life Cycle (SDLC).
77

88
## Coding Standards
99

10-
When writing code, the following principles should be observed.
10+
When writing code, the following principles should be observed:
1111

12-
- **Style**: Code shall be written for clear readability. Uniform and clear naming
13-
conventions, module structure, and formatting requirements shall be established
14-
across all components of the project. Python's
15-
[PEP8](https://www.python.org/dev/peps/pep-0008/#naming-conventions) standard offers
16-
clear guidance to this regard which can similarly be applied to all languages.
17-
- Python code is formatted with the [black](https://github.com/psf/black) code formatter.
18-
- Line length should be a maximum of 88 characters.
12+
- **Style**: Code should be written for clear readability. Uniform and consistent naming
13+
conventions, module structures, and formatting requirements must be established across
14+
all components of the project.
1915

20-
- **Maintenance Overhead**: Code base size should be noted to prevent large,
21-
unnecessarily complex solutions from being introduced. The idea is that the larger
22-
the code base, the more there is to review and maintain. Therefore, we should aim
23-
to find a compromise where we can keep the code base from becoming too large
24-
without adding convoluted complexity.
16+
- Python's [PEP8](https://www.python.org/dev/peps/pep-0008/#naming-conventions)
17+
standard offers clear guidances that can be applied to all languages.
2518

26-
- **Performance**: Performance drawbacks should be avoided, controlled, or, at least, be
27-
properly monitored and justified. For instance: memory management, garbage
28-
collection, disk reads/writes, and processing overhead should be regarded to ensure
29-
that an efficient solution is achieved.
19+
- Python code should be formatted using the
20+
[black code formatter](https://github.com/psf/black).
21+
- The maximum line length should be **88 characters**.
22+
23+
- **Maintenance Overhead**: The size of the codebase should be considered to prevent
24+
unnecessarily large or complex solutions. As the codebase grows, the effort to review
25+
and maintain it increases. Therefore, the goal is to find a balance that pevents the
26+
codebase from becoming too large while avoiding convoluted complexity.
27+
28+
- **Performance**: Performance issues should be avoided, controlled, or, properly
29+
justified. Considerations like memory management, garbage collection, disk
30+
reads/writes, and processing overhead must be addressed to ensure an efficient
31+
solution.
3032

3133
## Automated Testing
3234

3335
All components and their revisions must include appropriate automated software testing
3436
to be considered for release. The core framework must undergo thorough performance
3537
evaluation and comprehensive integration testing.
3638

37-
Generally, this includes tests related to:
39+
Testing generally includes:
3840

3941
- **Syntax**: Verify that the code base does not contain any syntax errors and will run
40-
or compile successfully.
42+
or compile successfully.
4143

4244
- **Unit & Integration**: Verify that low-level, method-specific tests (unit tests) and
43-
any tests related coordinated interface between methods (integration tests) pass
44-
successfully. Typically, when bugs are patched or features are introduced, unit and
45-
integration tests are added to ensure that the use-case intended to be satisfied is
46-
accounted for. This helps us prevent any regression in functionality.
45+
any tests related coordinated interface between methods (integration tests) pass
46+
successfully. Typically, when bugs are patched or features are introduced, unit and
47+
integration tests are added to ensure that the use-case intended to be satisfied is
48+
accounted for. This helps us prevent any regression in functionality.
4749

4850
- **Style**: Verify that the code base adheres to style guides for optimal readability.
4951

5052
- **Code Coverage**: Verify that the code base has similar or better code coverage than
51-
the last run.
53+
the last run.
5254

5355
## Code Reviews
5456

@@ -61,28 +63,26 @@ acceptance by DataJoint core team into the main code repository.
6163
GitHub fork and open a pull request targeting the `main` branch once ready for review.
6264

6365
- **Etiquette**: An author who has requested for a code for review should not accept and
64-
merge their own code to the code base. A reviewer should not commit any suggestions
65-
directly to the authors proposed changes but rather should allow the author to
66-
review.
66+
merge their own code to the code base. A reviewer should not commit any suggestions
67+
directly to the authors proposed changes but rather should allow the author to review.
6768

6869
- **Coding Standards**: Ensure the above coding standards are respected.
6970

7071
- **Summary**: A description should be included that summarizes and highlights the
71-
notable changes that are being proposed.
72+
notable changes that are being proposed.
7273

7374
- **Issue Reference**: Any bugs or feature requests that have been filed in the issue
74-
tracker that would be resolved by acceptance should be properly linked and
75-
referenced.
75+
tracker that would be resolved by acceptance should be properly linked and referenced.
7676

7777
- **Satisfy Automated Tests**: All automated tests associated with the project will be
7878
verified to be successful prior to acceptance.
7979

8080
- **Documentation**: Documentation should be included to reflect any new feature or
81-
behavior introduced.
81+
behavior introduced.
8282

8383
- **Release Notes**: Include necessary updates to the release notes or change log to
84-
capture a summary of the patched bugs and new feature introduction. Proper linking
85-
should be maintained to associated tickets in issue tracker and reviews.
84+
capture a summary of the patched bugs and new feature introduction. Proper linking
85+
should be maintained to associated tickets in issue tracker and reviews.
8686

8787
## Release Process
8888

@@ -108,8 +108,8 @@ upon request.
108108
All components will be organized in GitHub repositories with guidelines for
109109
contribution, feedback, and issue submission to the issue tracker. For more information
110110
on the general policy around issue filing, tracking, and escalation, see the
111-
[DataJoint Open-Source Contribute](../../../community/contribute) policy. For
112-
research groups that reach out to us, our team will work closely to collect feedback
113-
and resolve issues. Typically issues will be prioritized based on their criticality and
114-
impact. If new feature requirements become apparent, this may trigger the creation of a
115-
separate workflow or a major revision of an existing workflow.
111+
[DataJoint Open-Source Contribute](../../../community/contribute) policy. For research
112+
groups that reach out to us, our team will work closely to collect feedback and resolve
113+
issues. Typically issues will be prioritized based on their criticality and impact. If
114+
new feature requirements become apparent, this may trigger the creation of a separate
115+
workflow or a major revision of an existing workflow.

src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to the DataJoint Documentation
1+
# **Welcome to the DataJoint Documentation**
22

33
![pipeline](https://raw.githubusercontent.com/datajoint/datajoint-python/master/images/pipeline.png){: style="height:300px;"}
44

@@ -20,7 +20,7 @@
2020

2121
[:octicons-arrow-right-24: Learn more](./elements/)
2222

23-
- **DataJoint Works**
23+
- **DataJoint Platform**
2424

2525
---
2626

src/partnerships/facemap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ and Facemap.
8888
- [x] Mechanism to run Facemap within DataJoint Elements -
8989
[Element Facemap](https://github.com/datajoint/element-facemap/blob/0ccab4ec6731cd612e7cf61a221c64fb9bf22566/element_facemap/facial_behavior_estimation.py#L259-L266)
9090

91-
- [ ] Tutorials on running DataJoint Element with Facemap
91+
- [x] Tutorials on running DataJoint Element with Facemap - [Tutorial](https://github.com/datajoint/workflow-facemap/blob/main/notebooks/01-Facemap-DataJoint.ipynb)
9292

9393
- [ ] Tests to verify loading Facemap data
9494

src/partnerships/incf.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
# INCF
1+
# International Neuroinformatics Coordinating Facility (INCF)
22

33
DataJoint is a [company member of the INCF](https://www.incf.org/network/companies).
4+
5+
In 2023, Dr. Milagros Marín and Dr. Dimitri Yatsenko presented "Research workflows for collaborative neuroscience" at INCF Neuroinformatics Assembly.
6+
7+
From 2023 to 2025, Dr. Milagros Marín is a member of the INCF Council for Training, Science, and Infrastructure (CTSI) and the INCF Training and Education Committee (TEC).
8+
9+
In 2024, Dr. Dimitri Yatsenko served as the Chair of the Industry Advisory Council for the INCF.
10+
11+
In 2025, Dr. Milagros Marín joined the Scientific Collaboration and Education Theme Team (Neuro Community).

src/projects/publications.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,16 @@ Title: Publications
66
The following publications relied on DataJoint open-source software for data analysis. If your work uses DataJoint or DataJoint Elements, please cite the respective
77
[manuscripts and RRIDs](../about/citation.md).
88

9+
## 2025
10+
11+
+ Ding, Z., Fahey, P.G., Papadopoulos, S., Wang, E.Y., Celii, B., Papadopoulos, C., Chang, A., Kunin, A.B., Tran, D., Fu, J. ... & Tolias, A. S. (2025). [Functional connectomics reveals general wiring rule in mouse visual cortex](https://doi.org/10.1038/s41586-025-08840-3). *Nature*, 640(8058), 459-469.
12+
913
## 2024
1014

15+
+ Reimer, M. L., Kauer, S. D., Benson, C. A., King, J. F., Patwa, S., Feng, S., Estacion, M. A., Bangalore, L., Waxman, S. G., & Tan, A. M. (2024). [A FAIR, open-source virtual reality platform for dendritic spine analysis. Patterns](https://doi.org/10.1016/j.patter.2024.101041), 5(9). *Patterns*, 5(9).
16+
17+
+ Gillon, C. J., Baker, C., Ly, R., Balzani, E., Brunton, B. W., Schottdorf, M., Ghosh, S., & Dehghani, N. (2024). [Open Data In Neurophysiology: Advancements, Solutions & Challenges](https://doi.org/10.48550/arXiv.2407.00976). ArXiv, arXiv:2407.00976v1.
18+
1119
+ Mosberger, A.C., Sibener, L.J., Chen, T.X., Rodrigues, H.F., Hormigo, R., Ingram, J.N., Athalye, V.R., Tabachnik, T., Wolpert, D.M., Murray, J.M. and Costa, R.M., 2024. [Exploration biases forelimb reaching strategies](https://www.cell.com/cell-reports/fulltext/S2211-1247(24)00286-9). *Cell Reports*, 43(4).
1220

1321
+ Guidera, J. A., Gramling, D. P., Comrie, A. E., Joshi, A., Denovellis, E. L., Lee, K. H., ... & Frank, L. M. (2024). [Regional specialization manifests in the reliability of neural population codes](https://doi.org/10.1101/2024.01.25.576941). *bioRxiv*, 2024-01.
@@ -22,7 +30,6 @@ The following publications relied on DataJoint open-source software for data ana
2230

2331
+ Papadopouli, M., Koniotakis, E., Smyrnakis, I., Savaglio, M. A., Psilou, E., Brozi, C., ... & Smirnakis, S. M. (2024). [Brain orchestra under spontaneous conditions: Identifying communication modules from the functional architecture of area V1](https://doi.org/10.1101/2024.02.29.582364). *bioRxiv*, 2024-02.
2432

25-
2633
## 2023 <!-- 5 -->
2734

2835
+ Celii, B., Papadopoulos, S., Ding, Z., Fahey, P. G., Wang, E., Papadopoulos, C., ... &

src/projects/teams.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ of Medicine to meet the needs of their own research. Below is a partial list of
4949
+ <a href="https://www.fmi.ch/research-groups/groupleader.html?group=35"> Andreas Luthi Lab </a>
5050
+ Harvard Medical School
5151
+ <a href="https://drugowitschlab.hms.harvard.edu" target="_blank">Jan Drugowitsch Lab</a>
52-
+ <a href="http://datta.hms.harvard.edu/">Datta Lab</a>
52+
+ <a href="http://datta.hms.harvard.edu/" target="_blank">Datta Lab</a>
5353
+ <a href="https://harveylab.hms.harvard.edu/" target="_blank">Harvey Lab</a>
5454
+ <a href="http://sabatini.hms.harvard.edu/" target="_blank">Sabatini Lab</a>
5555
+ <a href="https://smirnakislab.bwh.harvard.edu/" target="_blank">Stelios Smirnakis Lab</a>
@@ -126,7 +126,7 @@ of Medicine to meet the needs of their own research. Below is a partial list of
126126
+ <a href="https://www.mackelab.org" target="_blank">Macke Lab</a> (<a href="https://github.com/mackelab/epiphyte" target="_blank">GitHub</a>)
127127
+ University of Utah
128128
+ <a href="http://shcheglovitov-lab.utah.edu/" target="_blank">Oleksandr Shcheglovitov Lab</a> (<a href="https://github.com/yueqiw/ephys_analysis" target="_blank">GitHub</a>)
129-
+ <a href="https://neuroscience.med.utah.edu/faculty/kubanek.php">Jan Kubanek Lab</a>
129+
+ <a href="https://neuroscience.med.utah.edu/faculty/kubanek.php" target="_blank">Jan Kubanek Lab</a>
130130

131131
+ University of Valencia
132132
+ <a href="https://scholar.google.com/citations?user=2NKBJkEAAAAJ" target="_blank">Kai-Hendrik Cohrs</a>

0 commit comments

Comments
 (0)