devops: adds some basic open-source structure

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,10 @@
+---
+name: Enhancement Template
+about: An enhancement for the project
+labels: enhancement
+title: ""
+---
+
+Description
+===========
+A clear and concise description of what the issue is about.

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,29 @@
+---
+name: Bug Report
+about: Create a report of a bug or problem
+labels: bug
+title: "bug: "
+---
+
+Describe the bug
+================
+A clear and concise description of what the bug is.
+
+To Reproduce
+============
+Steps to reproduce the behavior:
+1. Do X
+2. Type Y
+3. ...
+
+Expected behavior
+=================
+A clear and concise description of what you expected to happen.
+
+Screenshots
+===========
+If applicable, add screenshots to help explain your problem.
+
+Additional context
+==================
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,22 @@
+---
+name: Enhancement
+about: New/updated functionality
+labels: enhancement
+title: "enhancement: "
+---
+
+Current Situation
+=================
+A clear and concise description of what the current functionality is.
+
+Enhancement
+===========
+A quick description of the proposed enhancement
+
+Reasoning
+=========
+Why should this enhancement be added to the repository?
+
+Implementation
+==============
+Overview of possible implementations

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+What does this PR do?
+=====================
+
+Why are we doing this?
+======================
+
+Testing performed
+=================
+
+Known bugs/limitations
+======================

ARCHITECTURE.md

@@ -0,0 +1,3 @@
+todo
+
+context: https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html

CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+Be excellent to each other

CONTRIBUTING.md

@@ -0,0 +1 @@
+todo

CONTRIBUTORS.md

@@ -0,0 +1 @@
+todo

README.md

@@ -1,2 +1,39 @@
-# snn-sound-localization
+# SNN Sound Localization
+
 Training spiking neural networks for sound localization
+
+## Workflow
+
+A detailed description can be found in the `CONTRIBUTING.md` file. Briefly, the `notebooks/` directory is a
+free-for-all, just try to keep your work in your own notebook to avoid conflicts. When you have a polished piece of work
+(e.g. to generate a figure for the paper), open a pull request to add it to the `spikeloc/` directory where the "finished"
+code lives. Code must be reviewed before being merged into `spikeloc/`.
+
+If you need help with using git/Github, just ask in the discord and someone will lend a hand!
+
+## Installation
+
+Multiple installation methods are supported: conda (environment.yml), poetry (pyproject.toml), pip
+(requirements.txt), docker (DOCKERFILE)
+
+### Conda
+
+1. `conda env create -f environment.yml`
+2. `conda activate spikeloc`
+
+### Poetry
+
+1. Install [Poetry](https://python-poetry.org/)
+2. (optional) Create a virtualenv: `python -m venv .venv`
+3. (optional) Source the newly created virtualenv: `source .venv/bin/activate`
+4. Run `poetry install`
+
+### Pip
+
+1. Create a virtualenv: `python -m venv .venv`
+2. Source the newly created virtualenv: `source .venv/bin/activate`
+3. Run `pip install -r requirements.txt`
+
+## Community
+
+Find us on Discord [here](https://discord.gg/Zpd6RYYyuf)

environment.yml

@@ -0,0 +1,7 @@
+name: spikeloc
+channels:
+  - conda-forge
+dependencies:
+  - python>=3.8
+  - matplotlib
+  - jupyter