Skip to content

Commit

Permalink
Add new project types (#70)
Browse files Browse the repository at this point in the history
* Add new project types

* Update links

* First draft of electrophysiology page.

Please review

* Update collaborations.md

Please review, I think this is okay maybe I can run it by Pierre.

* Update docs/source/projects/developer_tools.md

Co-authored-by: Chang Huan Lo <[email protected]>

* Update docs/source/projects/electrophysiology.md

Co-authored-by: Chang Huan Lo <[email protected]>

* Update neuroblueprint link to website

* Update docs/source/projects/electrophysiology.md

Co-authored-by: Chang Huan Lo <[email protected]>

* Update docs/source/projects/electrophysiology.md

Co-authored-by: Chang Huan Lo <[email protected]>

* Added card images for data management and behaviour

* same backgrounds for all cards

* added collaborations card

* added ephys card

* Added movement text

* Standardise headings

* Remove collaborations for now

* edited movement text

---------

Co-authored-by: Joe Ziminski <[email protected]>
Co-authored-by: Chang Huan Lo <[email protected]>
Co-authored-by: niksirbi <[email protected]>
  • Loading branch information
4 people authored Oct 24, 2023
1 parent c96ccb4 commit 2aaec92
Show file tree
Hide file tree
Showing 14 changed files with 74 additions and 10 deletions.
Binary file removed docs/source/_static/SWC-BIDS_card.png
Binary file not shown.
Binary file added docs/source/_static/behaviour_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/blank_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/collaborations_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/data-management_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/dev-tools_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/electrophysiology_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/neuroanatomy_card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
32 changes: 24 additions & 8 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,46 @@ The NIU is dedicated to the development of high quality, accurate, robust, easy
::::{grid} 1 2 2 3
:gutter: 3

:::{grid-item-card} {fas}`brain;sd-text-danger` Neuroanatomy
:::{grid-item-card} {fas}`brain;sd-text-primary` Neuroanatomy
:img-top: _static/neuroanatomy_card.png
:link: projects/neuroanatomy
:link-type: doc
:::

Tools for analysing neuroanatomical data.
:::{grid-item-card} {fas}`video;sd-text-primary` Behaviour
:img-top: _static/behaviour_card.png
:link: projects/behaviour
:link-type: doc
:::

:::{grid-item-card} {fas}`database;sd-text-warning` Data Management
:img-top: _static/SWC-BIDS_card.png
:link: projects/data_management
:::{grid-item-card} {fas}`bolt;sd-text-primary` Electrophysiology
:img-top: _static/electrophysiology_card.png
:link: projects/electrophysiology
:link-type: doc
:::

Tools to help with structuring project folders and transferring data between computers.
:::{grid-item-card} {fas}`database;sd-text-primary` Data Management
:img-top: _static/data-management_card.png
:link: projects/data_management
:link-type: doc
:::

:::{grid-item-card} {fas}`code;sd-text-primary` Developer Tools
:img-top: _static/dev-tools_card.png
:link: projects/developer_tools
:link-type: doc

Tools to help with software development.
:::

[//]: # (:::{grid-item-card} {fas}`handshake;sd-text-primary` Collaborations)

[//]: # (:img-top: _static/collaborations_card.png)

[//]: # (:link: projects/collaborations)

[//]: # (:link-type: doc)

[//]: # (:::)

::::

```{toctree}
Expand Down
10 changes: 10 additions & 0 deletions docs/source/projects/behaviour.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Behaviour

## movement
[movement](https://movement.neuroinformatics.dev/) aims to **facilitate the study of animal behaviour in neuroscience** by providing a suite of **Python tools to analyse body movements** across space and time.

At its core, movement handles trajectories of *keypoints*, which are specific body parts of an *individual*. An individual's posture or *pose* is represented by a set of keypoint coordinates, given in 2D (x,y) or 3D (x,y,z). The sequential collection of poses over time forms *pose tracks*. In neuroscience, these tracks are typically extracted from video data using software like [DeepLabCut](http://www.mackenziemathislab.org/deeplabcut) or [SLEAP](https://sleap.ai/).

With movement, our vision is to present a consistent interface for pose tracks and to analyse them using modular and accessible tools. We aim to accommodate data from a range of pose estimation packages, in 2D or 3D, tracking a single or multiple individuals. The focus will be on providing functionalities for data cleaning, visualisation and motion quantification.

While movement isn't designed for behaviour classification or action segmentation, it may extract features useful for these tasks. We are planning to develop separate packages for this purpose, which will be compatible with movement and the existing ecosystem of related tools.
5 changes: 5 additions & 0 deletions docs/source/projects/collaborations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Collaborations

## UNLE

We have collaborated with Gatsby researcher Pierre Glasser in the productionasation of the UNLE package. UNLE (unnormalised neural likelihood estimation) provide two new methods for simulation-based inference (SBI), a form of Bayesian inference on the outputs of high-fiedelity simulators of natural phenomenon.
26 changes: 24 additions & 2 deletions docs/source/projects/developer_tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Below is a selection of the development tools we use and maintain in the Neuroin

The Python Cookiecutter template allows quick and easy setup of new python projects.
Projects built using this template contain pre-set configurations for code quality checks, formatting,
automated testing (pytest, both locally and through GitHub Actions), versioning and release on PyPi.
automated testing (pytest, both locally and through GitHub Actions), versioning and release on PyPI.

<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
Expand All @@ -27,7 +27,7 @@ automated testing (pytest, both locally and through GitHub Actions), versioning
## Fancylog

Fancylog is a tool that provides a convenient interface for python logging operations, including logging
when multiprocessing, logging information about the git environment, command-line arguments and object attributes.
when multiprocessing, logging information about the git environment, command-line arguments, and object attributes.


<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
Expand All @@ -44,4 +44,26 @@ when multiprocessing, logging information about the git environment, command-lin
</p>
</div>
</div>
</div>

## Actions

The actions repository hosts reliable, maintained and versioned [GitHub Actions](https://github.com/features/actions)
workflows for common tasks such as linting, testing, and releasing Python projects to PyPI.


<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-2 sd-row-cols-xs-2 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-2 docutils">
<div class="sd-col sd-d-flex-column sd-col-auto sd-col-xs-auto sd-col-sm-auto sd-col-md-auto sd-col-lg-auto docutils">
<p class="sd-text-left">
<a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary sd-shadow-sm reference external" href="https://github.com/neuroinformatics-unit/actions" target="_blank">
<span>
GitHub
<span class="fab fa-github">
</span>
</span>
</a>
</p>
</div>
</div>
</div>
9 changes: 9 additions & 0 deletions docs/source/projects/electrophysiology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Electrophysiology

## spikewrap

[Spikewrap](https://github.com/neuroinformatics-unit/spikewrap) is a tool to simplify the execution and visualisation of extracellular electrophysiology pre-processing and spike-sorting pipelines. Taking input organised to our [NeuroBlueprint](https://neuroblueprint.neuroinformatics.dev) standard, it will provide a flexible way to process an entire project's electrophysiological data with an easy-to-use interface.

Under the hood Spikewrap utilises the power of [SpikeInterface](https://spikeinterface.readthedocs.io/en/latest/), an open-source tool with many contributors in the electrophysiology analysis field. Spikewrap aims to abstract away the implementation details to allow researchers to test different pipeline configurations with the click of a button.

We actively contribute to the development of SpikeInterface, ensuring that our efforts benefit existing community projects.
2 changes: 2 additions & 0 deletions docs/source/projects/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ At the NIU we undertake several projects, listed below.
:maxdepth: 2
neuroanatomy
behaviour
electrophysiology
data_management
developer_tools
```

0 comments on commit 2aaec92

Please sign in to comment.