The NEMAR ecosystem

NEMAR is not a single application; it is a set of cooperating systems. This page is the map. The command-line interface (CLI) is where most users start, but it is one client of a larger platform, and more parts are joining over time.

How the pieces connect

flowchart TB
  User([Researcher])
  CLI["nemar CLI"]
  Web["ww2.nemar.org<br/>dataset browser"]
  API["api.nemar.org<br/>Workers + D1"]
  Data["data.nemar.org<br/>files · manifests · zips"]
  Zarr["zarr.nemar.org<br/>signal viewer"]
  GH[("GitHub<br/>metadata + git-annex")]
  S3[("S3<br/>data blobs")]
  DOI["Zenodo / EZID<br/>DOIs"]

  User --> CLI
  User --> Web
  CLI --> API
  Web --> API
  Web --> Data
  Web --> Zarr
  API --> GH
  API --> S3
  API --> DOI
  Data --> S3
  Zarr --> S3

Surfaces

Part	URL	Role	Docs
CLI	`nemar`	Upload, validate, version, download, and manage datasets from the terminal	CLI
Backend API	`api.nemar.org`	Auth, dataset lifecycle, admin, publication, DOIs (Cloudflare Workers + D1)	Platform API
Data plane	`data.nemar.org`	Public dataset files, version manifests, `records.json`, archive zips	Data API
Dataset browser	`ww2.nemar.org`	The current web browser for datasets (Astro)	external
Signal viewer	`zarr.nemar.org`	In-browser EEG/EMG viewer streaming per-recording Zarr	external
Legacy site	`nemar.org`	Original PHP dataexplorer; being replaced by `ww2.nemar.org`	external

How a dataset flows through NEMAR

flowchart LR
  A[Prepare BIDS] --> B[Validate]
  B --> C[Upload<br/>CLI or web]
  C --> D[Private GitHub repo<br/>+ S3 blobs]
  D --> E[Admin mints<br/>concept DOI]
  E --> F[Versioned release<br/>+ version DOI]
  F --> G[Public on<br/>data.nemar.org + ww2]
  G --> H[Recordings to<br/>Zarr viewer]

A researcher prepares a BIDS dataset and validates it with the CLI.
The CLI registers the dataset through the backend API, which creates a private GitHub repository (metadata + git-annex pointers) and provisions S3 storage for the data blobs.
Data files upload to S3; metadata is versioned in GitHub.
An admin mints a concept DOI; the researcher cuts versioned releases (each with its own DOI).
On publication the dataset becomes public on the data plane (data.nemar.org) and is surfaced in the browser (ww2.nemar.org); recordings are converted for the viewer.

Where to go next

New to NEMAR? Start with the CLI installation guide.
Building against the API or pulling data programmatically? See Platform & APIs.
A NEMAR administrator? See the admin documentation (access-gated).