https://github.com/sintef/oteapi-pipelines

Data documentation examples using oteapi
https://github.com/sintef/oteapi-pipelines

Last synced: about 2 months ago
JSON representation

Data documentation examples using oteapi

• Host: GitHub
• URL: https://github.com/sintef/oteapi-pipelines
• Owner: SINTEF
• Created: 2024-03-14T15:39:42.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-10-29T21:22:11.000Z (2 months ago)
• Last Synced: 2024-10-29T23:44:14.113Z (2 months ago)
• Language: Python
• Size: 72.3 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Demonstrators for OTEAPI

## Setup the OTEAPI Demo Environment

This guide will walk you through the process of setting up a demo environment for the OTEAPI framework.

OTEAPI is designed to enable FAIR data documentation and the execution of dataflow pipelines.

### Prerequisites

Before starting, ensure you have the following installed on your system:

- Docker and Docker Compose: For running the OTEAPI services and Redis in containers.

- Python 3: For setting up a virtual environment and running demo scripts.

### Step 1: Start the OTEAPI Services and Redis

1. Open a terminal and navigate to the directory containing the docker-compose.yml file.

2. Run the following command to start the OTEAPI services and Redis using Docker Compose:

   ```bash

   docker compose up -d

   ```

   This command downloads the necessary Docker images and starts the containers in the background.

### Step 2: Setup Your Local Python Environment

1. Create a Python virtual environment to isolate the demo dependencies:

   ```bash

   python3 -m venv ~/.virtualenvs/otedemo

   ```

2. Activate the virtual environment

   ```bash

   source ~/.virtualenvs/otedemo/bin/activate

   ```

3. Install the required Python packages:

   ```bash

   pip install -r requirements.txt

   ```

   This step ensures that all necessary Python dependencies are installed in your local environment.

### Step 3: Run the Demos

Choose demonstrations from the Demonstrations folder and follow the readme file to run the demo.

## Troubleshooting

- **Docker Compose Errors**: Ensure Docker is running on your system.

  If you encounter permission issues, try running the command with sudo.

- **Python Virtual Environment**: If you have multiple Python versions installed, ensure you're using Python 3 by replacing python3 with the specific version you want to use, e.g., python3.11.

- **Dependency Installation Issues**: Ensure you're in the activated virtual environment before installing dependencies.

  If you encounter any issues, consider upgrading pip using pip install --upgrade pip and try again.

## Conclusion

You've now successfully set up the environment and run the OTEAPI demo scripts.

These demos are designed to illustrate the capabilities and ease of integration offered by the OTEAPI framework.

Explore the scripts to better understand how OTEAPI works and how it can be adapted for your data integration needs.