Skip to content

Commit

Permalink
Merge branch 'main' into CellExplorerRecordingInterface
Browse files Browse the repository at this point in the history
  • Loading branch information
CodyCBakerPhD authored Dec 29, 2023
2 parents 4df5d37 + 4ade220 commit 333e55d
Show file tree
Hide file tree
Showing 132 changed files with 4,508 additions and 1,641 deletions.
1 change: 1 addition & 0 deletions .github/workflows/Build-and-deploy-mac.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Currently this is set to Ryan's Apple ID and app-specific password
teamId: ${{ secrets.APPLE_TEAM_ID }}
appleId: ${{ secrets.APPLE_ID }}
appleIdPassword: ${{ secrets.APPLE_PASSWORD }}
run: npm run deploy:mac
19 changes: 19 additions & 0 deletions .github/workflows/add-to-catalystneuro-dashboard.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Add Issue or Pull Request to Dashboard

on:
issues:
types:
- opened
pull_request:
types:
- opened

jobs:
add-to-project:
name: Add issue or pull request to project
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
with:
project-url: https://github.com/orgs/catalystneuro/projects/3
github-token: ${{ secrets.PROJECT_TOKEN }}
8 changes: 6 additions & 2 deletions .github/workflows/chromatic.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
name: "Chromatic Publish"
name: Chromatic

on: workflow_dispatch
on:
workflow_dispatch:
pull_request_review:
types: [submitted]

jobs:
test:
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request_review' && github.event.review.state == 'approved')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ repos:
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/psf/black
rev: 23.9.1
rev: 23.12.1
hooks:
- id: black
exclude: ^docs/
- repo: https://github.com/pre-commit/mirrors-prettier
rev: "v3.0.3"
rev: "v4.0.0-alpha.8"
hooks:
- id: prettier
types_or: [css, javascript]
6 changes: 6 additions & 0 deletions .storybook/preview-head.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<script>
window.global = window;
</script>

<style>
:root {
font-family: sans-serif;
}
</style>
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) <year> <copyright holders>
Copyright (c) 2017-2023, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
90 changes: 1 addition & 89 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,7 @@
<h3 align="center">NWB Graphical User Interface for Data Entry</h3>
</p>

> **Note:** This project is under heavy pre-release development and is not recommended for practical use.

<!-- TABLE OF CONTENTS -->

## Table of Contents

- [About](#about)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Contributing](#contributing)

## About
NWB GUIDE is a desktop app that provides a no-code user interface for converting neurophysiology data to NWB.

<p align="center">
Expand All @@ -24,82 +13,5 @@ NWB GUIDE is a desktop app that provides a no-code user interface for converting
</p>



## Installation

Begin by downloading the latest release from the [GitHub release page](https://github.com/NeurodataWithoutBorders/nwb-guide/releases).

### Windows

Run the `setup.exe` file and follow all instructions.

### MacOS

Run the `.dmg` file and follow all instructions to move the file into your Applications folder.

### Ubuntu

Please follow the [Developer Instructions](#developer-installation) on the [linux-fix](https://github.com/neurodatawithoutborders/nwb-guide/tree/linux-fix) branch of the NWB GUIDE.



## Developer Installation

Start by cloning the repository

```
git clone https://github.com/catalystneuro/nwb-guide
```

Install the appropriate Python dependencies for your operating system.

### Windows
```bash
conda env create -f ./environments/environment-Windows.yml
```

### Mac
```bash
conda env create -f ./environments/environment-MAC.yml
```

### M1 Mac
```bash
conda env create -f ./environments/environment-MAC-arm64.yml
```

### Linux
```bash
conda env create -f ./environments/environment-Linux.yml
```

## Getting Started
Before starting NWB GUIDE, you'll need to ensure that the Python environment is activated.

```bash
conda activate nwb-guide
```

Next, install all JavaScript dependencies based on the `package-lock.json` file.

```bash
npm ci
```

You can now run the following command to start the application using Electron.

```bash
npm start
```

## Contributing

### Repo Structure
#### NWB GUIDE
1. `/src` - Contains all the source code for the frontend
- `index.js` - The entry point for the application
- `pages.js` - The main code that controls which pages are rendered and how they are linked together
- `stories` - Contains all the Web Components and related Storybook stories
- `electron` - Contains all the Electron-related code to enable conditional inclusion for development mode
- `assets` - Contains all the frontend-facing assets (e.g. images, css, etc.)
2. `/pyflask` - Contains all the source code for the backend
See the installation instructions in our [documentation](https://nwb-guide.readthedocs.io/en/latest/installation.html).
2 changes: 2 additions & 0 deletions docs/conf_extlinks.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Use this for mapping to external links
extlinks = {
"linux-fix": ("https://github.com/neurodatawithoutborders/nwb-guide/tree/linux-fix/%s", "%s"),
"releases": ("https://github.com/NeurodataWithoutBorders/nwb-guide/releases/%s", "%s"),
"pynwb-docs": ("https://pynwb.readthedocs.io/en/stable/%s", "%s"),
"matnwb-src": ("https://github.com/NeurodataWithoutBorders/matnwb/%s", "%s"),
"nwb-overview": ("https://nwb-overview.readthedocs.io/en/latest/%s", "%s"),
Expand Down
Loading

0 comments on commit 333e55d

Please sign in to comment.