Reproducible Research Platform VSCode Player Bundle

RRP VS Code IDE

Reproducible Research Platform (RRP) project including the VS Code IDE.

Overview

This RRP project repository demonstrates the use of Visual Studio, a real editor (Integrated development environment, IDE) and alternative to JupyterLab.

The main outcome of this example is:

Example of VS Code.

Features

Integration with RRP and openBIS ELN-LIMS: Mounts data from the research data management system openBIS in RRP for direct use to work on software tools added as submodules.

IDE: Keeping user habits allowing to work with a real IDE and debugger.

Installation

Prerequisites

Local Docker installation.

Steps

Download and extract the .zip file

Run the play script for your operating system

Linux / macOS: play

Windows: play.bat or play.ps1

Usage

In RRP start VSCode.

Workflow Overview

Testing & Coding: Start VSCode, navigate to examples and run run_demo.py.

Directory Structure

├── .binder/ # Environment specifications, Python version, packages etc.
├── .rrp/ # Specification of openBIS server and required data from RDMS openBIS ELN-LIMS (e.g. data)
├── .vscode/ # VS code settings
├── LICENSES # Additional licenses
├── examples # Example code
│ └── run_demo.py # Example code
├── jupyter_vscode_proxy # Proxy setup
├── .flake8 # Style guide config
├── .pre-commit-config.yaml # Pre comit config
├── LICENSE # License
├── MANIFEST.in # Manifest
├── NOTICE # License details
├── README.md # This file
└── pyproject.toml # Package config file

Contributing

We welcome contributions to improve this repository! Please follow these steps:

Fork the repository.

Create a new branch for your feature or bug fix.

Submit a pull request with a clear description of your changes.

Authors and acknowledgment

Andreas P. Cuny, ETH Zurich initial implementation

Additionally, we acknowledge VS Code on Binder

License

This project is licensed under the Apache 2.0 License. See LICENSE file for details.

Copyright © 2020-2025 ETH Zurich, Andreas P. Cuny, D-BSSE, CSB Group