Quickstart

Caution

This documentation is still under development.

To install the OxyGenie package and start simulating vascular networks, follow the steps below:

Installation

1. Prerequisites

Ensure that Python >3.9 is installed on your system. If you haven’t installed Python, you can download it from the official Python website.

2. Create a virtual environment (Optional)

It is recommended to create a virtual environment to isolate project dependencies. Open a terminal or command prompt and run the following commands:

On macOS and Linux:

python3 -m venv myenv
source myenv/bin/activate

On Windows:

python -m venv myenv
myenv\Scripts\activate

3. Install the required packages

In the virtual environment or your Python environment, run the following command to install the necessary packages:

pip install -r requirements.txt

4. Install the OxyGenie package

Download the OxyGenie repository from the source code available on GitHub.

5. Import the library

Once the library is downloaded, navigate to the project directory. At the root of the project, you can use the following code to import the package:

from OxyGenie.diffusion import *
import OxyGenie.pgvnet as pvg
from OxyGenie.learn import *

Tip

Now that you have installed all the required prerequisites and dependencies, feel free to consult the library documentation for more information on usage and the various functions available.