Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,38 @@

## Installation

Install using pip
```
### Requirements
- Python >= 3.7
- CUDA-compatible GPU (optional, but recommended for faster training)

### Install from PyPI

Install the latest stable version using pip:
```bash
pip install genevector
```
or install from Github
```

### Install from Source

For the latest development version, install directly from GitHub:

```bash
# Clone the repository
git clone https://github.com/nceglia/genevector.git
cd genevector

# Create and activate a virtual environment (recommended)
python3 -m venv gvenv
source gvenv/bin/activate
python3 pip install -r requirements.txt
python3 setup.py install
source gvenv/bin/activate # On Windows: gvenv\Scripts\activate

# Install dependencies and package
pip install -r requirements.txt
pip install .
```

For development, install in editable mode:
```bash
pip install -e .
```
## Tutorials (see "example" directory)

Expand Down