add environment.yaml

This commit is contained in:
2025-03-30 04:57:51 -05:00
parent ac86d6cf20
commit 8edf291cfa
2 changed files with 211 additions and 19 deletions

View File

@@ -9,28 +9,12 @@ There are jupyter notebooks in /notebooks covering these topics:
## Installation
- Python version 3.10 or greater is required
- Install pyenv or conda for environment management
- Install conda (or your preferred tool) for environment management
### Option 1: Using conda
### Using conda
```bash
# Create a new conda environment named pynkode
conda create -n pynkode python=3.10
# Activate the environment
conda env create -f environment.yml
conda activate pynkode
# Install the requirements
pip install -r requirements.txt
```
### Option 2: Using pyenv
```bash
# Install Python 3.10 using pyenv
pyenv install 3.10.0
# Create a virtualenv named pynkode
pyenv virtualenv 3.10.0 pynkode
# Set the local version to pynkode
pyenv local pynkode
# Install the requirements
pip install -r requirements.txt
```
## Starting a Jupyter Notebook