chrisjsewell / aiida-vcode-ext

A VSCode Extension for visualising AiiDA repositories
https://marketplace.visualstudio.com/items?itemName=chrisjsewell.aiida-explore-vscode
MIT License
3 stars 0 forks source link

AiiDA VSCode Extension [IN DEVELOPMENT]

VS Marketplace Github-CI

A VSCode Extension for working with and exploring AiiDA repositories.

screenshot

Setup

The extension requires at least a PostgreSQL client to be running locally (see here for example), that can connect to a database running on an open port (usually 5432). Then a connection can be configured directly in the settings or using the setup helper:

screenshot

Develoment

Testing is run against a Docker compose environment, with Node.js version 12 and ava as the test runner. To run the tests, make sure you have Docker installed, then launch the containers:

$ cd docker
$ docker-compose up -d
$ docker-compose ps
     Name                   Command              State           Ports
-------------------------------------------------------------------------------
aiida-core       /sbin/my_init                   Up
aiida-database   docker-entrypoint.sh postgres   Up      0.0.0.0:5432->5432/tcp

Linting and tests can then be run after installing the node packages:

$ npm ci
$ npm run lint:fix
$ npm test

Note, when powering down the docker environment, its best to also remove the volumes:

$ docker-compose down -v