Skip to content

Commit

Permalink
chore: update installation docs and keep in sync with README (#243)
Browse files Browse the repository at this point in the history
  • Loading branch information
tedil authored Jan 15, 2025
1 parent 3613607 commit 06cc42d
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 25 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,14 @@ Tooling for connecting GitLab, pipelines, and SODAR at CUBI.

## Getting Started

Prerequisites when using conda:
Clone CUBI-TK, create a conda environment and install using [`uv`](https://docs.astral.sh/uv/).

```bash
$ git clone [email protected]:bihealth/cubi-tk.git
$ conda env create -n cubi-tk -f environment.yaml
$ conda activate cubi-tk
```

Clone CUBI-TK and install.

```bash
$ git clone [email protected]:bihealth/cubi-tk.git
$ cd cubi-tk
$ uv python pin 3.12
$ uv sync
$ uv pip install -e .
# or, if you need snappy kickoff:
Expand All @@ -33,7 +29,7 @@ $ uv pip install -e .
$ uv sync --all-extras --group docs
$ cd docs_manual
$ uv run make clean html
$ ls _build/html/index.html
$ xdg-open _build/html/index.html
```

## Argument Completion
Expand Down
26 changes: 10 additions & 16 deletions docs_manual/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,32 @@
Installation
============

Prerequisites when using conda:
Clone CUBI-TK, create a conda environment and install using [`uv`](https://docs.astral.sh/uv/).

.. code-block:: bash
$ conda create -n cubi-tk python=3.10
$ git clone [email protected]:bihealth/cubi-tk.git
$ conda env create -n cubi-tk -f environment.yaml
$ conda activate cubi-tk
Clone CUBI-TK and install:

.. code-block:: bash
$ git clone [email protected]:CUBI/Pipelines/cubi-tk.git
$ cd cubi-tk
$ pip install -e .
For building the manual or running tests you will need some more packages.

.. code-block:: bash
$ uv python pin 3.12
$ uv sync
$ uv pip install -e .
# or, if you need snappy kickoff:
#$ GIT_LFS_SKIP_SMUDGE=1 uv pip install -e '.[snappy]'
$ pip install -r requirements/develop.txt
Run tests
---------

.. code-block:: bash
$ make test
$ uv run make pytest
Build manual
------------

.. code-block:: bash
$ cd docs_manual
$ make clean html
$ uv run make clean html
3 changes: 2 additions & 1 deletion environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ channels:
name: cubi-tk

dependencies:
- python >=3.9
- python ~=3.12
- pip
- uv >=0.5
- pysam >=0.22
- vcfpy >=0.13.8
- gcc_linux-64 >=13,<14
- zlib ~=1.3.0
- liblzma ~=5.6.3

0 comments on commit 06cc42d

Please sign in to comment.