Installation Guide

Introduction

This guide will help you install Medicraft, the software designed to generate synthetic and diverse medical datasets from imaging information, specifically utilizing OCT eye scans.

Requirements

Before you begin, ensure you have the following prerequisites:

Python 3.10 or higher
pip (Python package installer)
Git (for cloning the repository)
Virtual environment tools (optional but recommended)

This guide will walk you through the steps required to install Medicraft. You have multiple options for installation: cloning the repository, installing as a package, using Conda, or using pip.

1. Clone the Repository

To get started, clone the Medicraft repository from GitHub and navigate to the project directory:

git clone https://github.com/yourusername/medicraft.git
cd medicraft

2. Installing as a Package

If you prefer to install Medicraft directly as a package, use the following pip command:

pip install git+https://github.com/yourusername/medicraft.git

Verify the installation by running:

python -m medicraft --version

3. Using Conda (Recommended)

Creating and activating a new Conda environment is recommended. Follow these steps:

conda create --name medicraft python=3.10
conda activate medicraft
conda install --file requirements.txt

Alternatively, if use environment.yml file by creating the environment with:

conda env create -f environment.yml

4. Using pip

If you prefer to use pip and virtual environments, follow these steps:

Create and activate a virtual environment (optional but recommended):

python -m venv venv

Activate the virtual environment:

On Windows:
```
venv\Scripts\activate
```
On macOS/Linux:
```
source venv/bin/activate
```

Install the required Python packages using pip:

pip install -r requirements.txt

Post-Installation Steps

After installing Medicraft, you can start using it to generate synthetic medical datasets. Refer to the Usage Guide for detailed instructions on how to use Medicraft.

Troubleshooting

If you encounter any issues during installation, check the following:

Ensure all prerequisites are installed and properly configured.
Verify that you have cloned the correct repository URL.
Make sure your virtual environment or conda environment is activated (if using one).

For additional support, you can reach out to our support team via GitHub issues or by sending an email to fp.patyk@gmail.com.