nfdi4plants / swate

Excel Add-In for annotation of experimental data and computational workflows.

Swate

Swate - something or someone that gets you absolutely joyed (Urban dictionary)

Swate is a Swate workflow annotation tool for excel.

Swate aims to provide a low-friction workflow annotation experience that makes the usage of controlled vocabularies (ontologies) as easy and intuitive as possible. It is designed to integrate in the familiar spreadsheet environment that is the center of a great deal of data-focused wetlab work.

Table of contents

• Docs
• Install/Use
• Contact

Docs

• Ontology term search
• ISA conform output
• Minimal information standards

Try our quickstart or a more in-depth walkthrough.

For a full in-depth view of all Swate features check the documentation.

Install/Use

Swate installation

Contact

If you have any issues using Swate, missing features or found a nasty bug 🐛 you can always contact us via:

• GitHub Issues
• DataPLANT Helpdesk

Dev

These instructions are only relevant if you too want to participate in developing Swate!

Requirements

• .NET SDK, >= 8.0.0
  • verify with dotnet --version
• nodejs, >=18
  • verify with node --version
• npm, >=9
  • likely part of nodejs installation
  • verify with npm --version
• docker, >= 24
  • verify with docker --version
  • this is required for database setup

Setup

• clone this repo
• Run dotnet tool restore
• Run npm install

Development

Start

./build.cmd run, to start up Swate (+ Database network)

Swate runs on localhost:8080 (and swobup on localhost:8000).

Available commands

Usage: ./build.cmd <command>

run (--nodb)                        Start .net backend server, vite frontend (and database, 
                                    swobup with docker if not `--nodb`)

release (pre)                       Run .net tests tag current branch and force push to 
                                    release branch (nightly if `pre`), this will trigger
                                    Github release with docker image

bundle                              Create distributable, used in docker image creation.

docker  
    create                          Create new swate:new image
                
    test                            Start test instance of docker compose network from swate:new image

version
    create-file <version>           Create new `src/Server/Version.fs` with `<version>`.