forked from LorenFrankLab/spyglass
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
38 changed files
with
2,494 additions
and
1,222 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
# Visit https://bit.ly/cffinit to generate yours today! | ||
|
||
cff-version: 1.2.0 | ||
title: spyglass | ||
title: 'Spyglass: a data analysis framework for reproducible and shareable neuroscience research' | ||
message: 'If you use this software, please cite it as below.' | ||
type: software | ||
authors: | ||
|
@@ -45,8 +45,8 @@ authors: | |
affiliation: 'University of California, San Francisco' | ||
orcid: 'https://orcid.org/0000-0003-4013-214X' | ||
- given-names: Rhino | ||
family-names: Nevers | ||
email: rhino.nevers@ucsf.edu | ||
family-names: Never | ||
email: rhino.never@ucsf.edu | ||
affiliation: 'University of California, San Francisco' | ||
- given-names: Philip | ||
family-names: Adenekan | ||
|
@@ -84,18 +84,18 @@ authors: | |
email: [email protected] | ||
affiliation: 'University of California, San Francisco' | ||
orcid: 'https://orcid.org/0000-0001-5559-2910' | ||
- given-names: Shin | ||
family-names: Donghoon | ||
- given-names: Donghoon | ||
family-names: Shin | ||
email: [email protected] | ||
affiliation: 'University of California, San Francisco' | ||
orcid: 'https://orcid.org/0009-0000-8916-7314' | ||
- given-names: Chiang | ||
family-names: Sharon | ||
- given-names: Sharon | ||
family-names: Chiang | ||
email: [email protected] | ||
affiliation: 'University of California, San Francisco' | ||
orcid: 'https://orcid.org/0000-0002-4548-4550' | ||
- given-names: Holobetz | ||
family-names: Cristofer | ||
- given-names: Cristofer | ||
family-names: Holobetz | ||
email: [email protected] | ||
affiliation: 'University College London' | ||
orcid: 'https://orcid.org/0009-0009-8567-3290' | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# Features | ||
|
||
This directory contains a series of explainers on tools that have been added to | ||
Spyglass. | ||
|
||
- [Export](./Export.md) - How to export an analysis. | ||
- [FigURL](./FigURL.md) - How to use FigURL to share figures. | ||
- [Merge Tables](./Merge.md) - Tables for pipeline versioning. | ||
- [Mixin](./Mixin.md) - Spyglass-specific functionalities to DataJoint tables, | ||
including fetching NWB files, long-distance restrictions, and permission | ||
checks on delete operations. | ||
- [Session Groups](./SessionGroups.md) - How to operate on sets of sessions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Contributing to Spyglass | ||
|
||
This document provides an overview of the Spyglass development, and provides | ||
guidance for folks looking to contribute to the project itself. For information | ||
on setting up custom tables, skip to Code Organization. | ||
|
||
## Development workflow | ||
|
||
New contributors should follow the | ||
[Fork-and-Branch workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow). | ||
See GitHub instructions | ||
[here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects). | ||
|
||
Regular contributors may choose to follow the | ||
[Feature Branch Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow) | ||
for features that will involve multiple contributors. | ||
|
||
## Code organization | ||
|
||
- Tables are grouped into schemas by topic (e.g., `common_metrics`) | ||
- Schemas | ||
- Are defined in a `py` pile. | ||
- Correspond to MySQL 'databases'. | ||
- Are organized into modules (e.g., `common`) by folders. | ||
- The _common_ module | ||
- In principle, contains schema that are shared across all projects. | ||
- In practice, contains shared tables (e.g., Session) and the first draft of | ||
schemas that have since been split into their own | ||
modality-specific\ | ||
modules (e.g., `lfp`) | ||
- Should not be added to without discussion. | ||
- A pipeline | ||
- Refers to a set of tables used for processing data of a particular modality | ||
(e.g., LFP, spike sorting, position tracking). | ||
- May span multiple schema. | ||
- For analysis that will be only useful to you, create your own schema. | ||
|
||
## Misc | ||
|
||
- During development, we suggest using a Docker container. See | ||
[example](../notebooks/00_Setup.ipynb). | ||
- `numpy` style docstrings will be interpreted by API docs. To check for | ||
compliance, monitor the output when building docs (see `docs/README.md`) | ||
|
||
## Making a release | ||
|
||
Spyglass follows [Semantic Versioning](https://semver.org/) with versioning of | ||
the form `X.Y.Z` (e.g., `0.4.2`). | ||
|
||
1. In `CITATION.cff`, update the `version` key. | ||
2. Make a pull request with changes. | ||
3. After the pull request is merged, pull this merge commit and tag it with | ||
`git tag {version}` | ||
4. Publish the new release tag. Run `git push origin {version}`. This will | ||
rebuild docs and push updates to PyPI. | ||
5. Make a new | ||
[release on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). |
File renamed without changes.
Oops, something went wrong.