installation_guide.md

Build from source

Pyenv and Poetry

We do not recommend using pip and your local python packages.

Use pyenv to manage your python version.

Use poetry for dependency management and packaging.

Use pipx to manage your local packages, which should just be poetry for this instance.

Install pyenv

Simply:

curl https://pyenv.run | bash
pyenv update

Install python v3.10 with pyenv

pyenv install 3.9
pyenv versions

Install pipx

on Ubuntu 23.04 or above:

sudo apt update
sudo apt install pipx
pipx ensurepath
sudo pipx --global ensurepath
exec $SHELL

on MacOS:

brew install pipx
pipx ensurepath
sudo pipx --global ensurepath
exec $SHELL

Install poetry with pipx

pipx install poetry
poetry config virtualenvs.prefer-active-python true
which poetry

Clone repos

git clone https://github.com/Geodefi/geoscope
cd geoscope

Create virtual env

poetry shell

Create virtual env with a specific version

poetry env use <python_version/3.9/3.9.19/etc>

This will output:

Using virtualenv: <path_to_venv> copy <path_to_venv> and use it above to activate

source <path_to_venv>/bin/activate

Running geoscope with poetry

git clone https://github.com/Geodefi/geoscope
cd geoscope
poetry install

Then, after cloning the repo you should create a dedicated folder with

poetry run geoscope config

Then, you can easily start geoscope with:

poetry run geoscope run

In case you want to run it on background put & after the command:

PYTHONPATH=. poetry run python src/main.py --flags &