diff --git a/.cruft.json b/.cruft.json index 0912980..b35585e 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,7 +1,7 @@ { "template": "https://github.com/scverse/cookiecutter-scverse", - "commit": "586b1652162ff7994b0070a034023d64289ae416", - "checkout": "v0.3.1", + "commit": "87a407a65408d75a949c0b54b19fd287475a56f8", + "checkout": "v0.4.0", "context": { "cookiecutter": { "project_name": "scCoral", diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 3d0b14d..826ff44 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -26,9 +26,9 @@ jobs: - os: ubuntu-latest python: "3.10" - os: ubuntu-latest - python: "3.11" + python: "3.12" - os: ubuntu-latest - python: "3.11" + python: "3.12" pip-flags: "--pre" name: PRE-RELEASE DEPENDENCIES diff --git a/.gitignore b/.gitignore index 0f3c108..bd29caa 100644 --- a/.gitignore +++ b/.gitignore @@ -18,6 +18,7 @@ __pycache__/ /.pytest_cache/ /.cache/ /data/ +/node_modules/ # docs /docs/generated/ diff --git a/README.md b/README.md index 4b99ad9..e35aa0e 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,14 @@ Increasing throughput in single-cell technologies enables researchers to create population-scale single-cell RNAseq datasets. An ongoing challenge in the analysis of this data is to link molecular features (i.e. single-cell gene expression) with patient-level covariates (e.g. disease severity, age, sex, ...). `sccoral` aims to find an interpretable link between subject/sample-level features and gene expression by embedding cellular metadata and gene expression in the same latent space of a variational autoencoder architecture {cite:p}`lopez2018`. By leveraging and improving the network architecture of linear scVI {cite:p}`svensson2020`, we aim to find a direct and interpretable link between embedded covariates and gene expression. +<<<<<<< ours +======= +You need to have Python 3.10 or newer installed on your system. If you don't have +Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge). +>>>>>>> theirs ### Installation diff --git a/docs/conf.py b/docs/conf.py index 2575b93..9ae1a89 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,5 @@ # Configuration file for the Sphinx documentation builder. -# + # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html @@ -36,10 +36,10 @@ html_context = { "display_github": True, # Integrate GitHub - "github_user": "lucas-diedrich", # Username - "github_repo": project_name, # Repo name - "github_version": "main", # Version - "conf_py_path": "/docs/", # Path in the checkout to the docs root + "github_user": "lucas-diedrich", + "github_repo": "https://github.com/lucas-diedrich/sccoral", + "github_version": "main", + "conf_py_path": "/docs/", } # -- General configuration --------------------------------------------------- diff --git a/docs/contributing.md b/docs/contributing.md index 0861dbb..a77620a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -51,7 +51,7 @@ and [prettier][prettier-editors]. ## Writing tests ```{note} -Remember to first install the package with `pip install '-e[dev,test]'` +Remember to first install the package with `pip install -e '.[dev,test]'` ``` This package uses the [pytest][] for automated testing. Please [write tests][scanpy-test-docs] for every function added diff --git a/pyproject.toml b/pyproject.toml index 1e1b06d..09e7659 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ name = "sccoral" version = "0.0.1" description = "Covariate informed scVI with linear decoder" readme = "README.md" -requires-python = ">=3.9" +requires-python = ">=3.10" license = {file = "LICENSE"} authors = [ {name = "Lucas Diedrich"}, @@ -37,7 +37,7 @@ doc = [ "docutils>=0.8,!=0.18.*,!=0.19.*", "sphinx>=4", "sphinx-book-theme>=1.0.0", - "myst-nb", + "myst-nb>=1.1.0", "sphinxcontrib-bibtex>=1.0.0", "sphinx-autodoc-typehints", "sphinxext-opengraph", @@ -102,7 +102,7 @@ ignore = [ "D107", # Errors from function calls in argument defaults. These are fine when the result is immutable. "B008", - # __magic__ methods are are often self-explanatory, allow missing docstrings + # __magic__ methods are often self-explanatory, allow missing docstrings "D105", # first line should end with a period [Bug: doesn't work with single-line docstrings] "D400",