Metadata-Version: 2.1
Name: element-animal
Version: 0.1.0b0
Summary: DataJoint Element for Animal Management
Home-page: https://github.com/datajoint/element-animal
Author: DataJoint NEURO
Author-email: info@vathes.com
License: MIT
Keywords: neuroscience animal-management datajoint
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: datajoint (>=0.13)

# DataJoint Element - Animal

There are two modules in `element-animal`:
+ subject: contains the basic information of subject, including Strain, Line, Subject, Zygosity, and SubjectDeath information
+ genotyping: this module is designed for labs that keep track of colony management and genotyping results, containing information of breeding, weaning, housing, and genotyping.

See [Background](Background.md) for the background information and development timeline.


## Installation
```
pip install element-animal
```

If you already have an older version of ***element-animal*** installed using `pip`, upgrade with
```
pip install --upgrade element-animal
```

## Element usage

+ `element-animal` is not a complete workflow by itself, but rather a modular design of tables and dependencies that can be flexibly attached to any DataJoint workflow.
+ See the [workflow-animal](https://github.com/datajoint/workflow-animal) repository for example usage of `element-animal`.

+ Also refer to the [workflow-calcium-imaging](https://github.com/datajoint/workflow-calcium-imaging) and [workflow-array-ephys](https://github.com/datajoint/workflow-array-ephys) repositories for example usages of `element-animal` when combining with other elements.

+ See the [datajoint-elements](https://github.com/datajoint/datajoint-elements) repository for a detailed description of the DataJoint elements and workflows.

## Element architecture

### Subject Diagram
![subject diagram](images/subject_diagram.svg)

### Genotyping Diagram
![genotyping diagram](images/genotyping_diagram.svg)




