Installation#
To use gcell from another project, install it using your favourite environment manager:
$ pip install git+https://github.com/GET-Foundation/gcell.git@main
Development Version#
To work with the latest version on GitHub: clone the repository and cd into its root directory.
$ gh repo clone GET-Foundation/gcell
$ cd gcell
$ uv sync --all-extras # install all dependencies
$ uv run pytest # run tests
$ uv run sphinx-build docs docs/_build # build docs
If you are using pip>=21.3, an editable install can be made:
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -e '.[dev,test]'
If you want to let conda handle the installations of dependencies, do:
$ pipx install beni
$ beni pyproject.toml > environment.yml
$ conda env create -f environment.yml
$ conda activate gcell
$ pip install -e '.[dev,doc,test]'
For instructions on how to work with the code, see the contribution guide.
Docker#
If you’re using Docker, you can use e.g. the image gcfntnu/gcell from Docker Hub.
Troubleshooting#
If you get a Permission denied error, never use sudo pip. Instead, use virtual environments or:
$ pip install --user gcell