search

NTNU-IndEcol / BuildME

6 stars 1 forks source link

Pip install #64

Open CBreton026 opened 2 years ago

CBreton026 commented 2 years ago

Hi! This is a first step towards #59.

Regarding the discussion here, I am unsure if we can automate the whole installation process.

However, it should work fine with anaconda (just like eppy) - I am working in a conda virtual environment and I can pip install BuildME with the proposed change.

The installation process is:

conda activate YOUR-VENV
cd ~/BuildME
pip install -e .

This installs BuildME as an editable package, which means it keeps track of its changes; there's no need to reinstall it after we change the repo. After, BuildME can be imported and used, regardless of the directory we are in (see the inspiration for this here: https://goodresearch.dev/setup.html#use-the-package).

nheeren commented 2 years ago

Thank you! This looks fine. As I said I have little experience with this, but I am happy to trust your judgement here. Only request I would like to make before merging: Would you mind adding some info to our docs? docs/setup.md would probably be a good place to start.

CBreton026 commented 1 year ago

@nheeren very well! I'll write something up and add it to docs/setup.md.