Skip to content

Commit f7e8b1c

Browse files
PauBadiaMclaude
andcommitted
Rename package from pygreta to gretapy
- Rename src/pygreta/ to src/gretapy/ - Update all imports from `import pygreta as pg` to `import gretapy as gt` - Update pyproject.toml with new package name and URLs - Update all documentation and API references - Update CI/CD workflows and issue templates - Rename GitHub repository to saezlab/gretapy Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 5f42960 commit f7e8b1c

44 files changed

Lines changed: 150 additions & 150 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Feature request
2-
description: Propose a new feature for pygreta
2+
description: Propose a new feature for gretapy
33
type: Enhancement
44
body:
55
- type: textarea

.github/workflows/release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
runs-on: ubuntu-latest
1212
environment:
1313
name: pypi
14-
url: https://pypi.org/p/pygreta
14+
url: https://pypi.org/p/gretapy
1515
permissions:
1616
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
1717
steps:

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# pygreta - Evaluation and analysis of Gene Regulatory Networks (GRNs)
1+
# gretapy - Evaluation and analysis of Gene Regulatory Networks (GRNs)
22
<img src="https://drive.google.com/uc?id=1DFGeAuSp8w1kDlMaS4zyeXfepKVW14Ym" align="right" width="120" class="no-scaled-link" alt='GRETA logo' />
33

44
[![Tests][badge-tests]][tests]
@@ -15,18 +15,18 @@
1515
[![Conda version][badge-condav]][conda]
1616
[![Conda downloads][badge-condad]][conda]
1717

18-
[badge-tests]: https://img.shields.io/github/actions/workflow/status/saezlab/pygreta/test.yaml?branch=main
18+
[badge-tests]: https://img.shields.io/github/actions/workflow/status/saezlab/gretapy/test.yaml?branch=main
1919
[badge-docs]: https://img.shields.io/readthedocs/gretapy
20-
[badge-condav]: https://img.shields.io/conda/vn/conda-forge/pygreta.svg
21-
[badge-condad]: https://img.shields.io/conda/dn/conda-forge/pygreta.svg
22-
[badge-issues]: https://img.shields.io/github/issues/saezlab/pygreta
23-
[badge-coverage]: https://codecov.io/gh/saezlab/pygreta/branch/main/graph/badge.svg
24-
[badge-pypi]: https://img.shields.io/pypi/v/pygreta.svg
25-
[badge-mdown]: https://static.pepy.tech/badge/pygreta/month
26-
[badge-adown]: https://static.pepy.tech/badge/pygreta
27-
[badge-stars]: https://img.shields.io/github/stars/saezlab/pygreta?style=flat&logo=github&color=yellow
20+
[badge-condav]: https://img.shields.io/conda/vn/conda-forge/gretapy.svg
21+
[badge-condad]: https://img.shields.io/conda/dn/conda-forge/gretapy.svg
22+
[badge-issues]: https://img.shields.io/github/issues/saezlab/gretapy
23+
[badge-coverage]: https://codecov.io/gh/saezlab/gretapy/branch/main/graph/badge.svg
24+
[badge-pypi]: https://img.shields.io/pypi/v/gretapy.svg
25+
[badge-mdown]: https://static.pepy.tech/badge/gretapy/month
26+
[badge-adown]: https://static.pepy.tech/badge/gretapy
27+
[badge-stars]: https://img.shields.io/github/stars/saezlab/gretapy?style=flat&logo=github&color=yellow
2828

29-
`pygreta` is a comprehensive framework for benchmarking and evaluating gene regulatory networks (GRNs) inferred from single-cell multiome (RNA+ATAC) data. It provides a systematic evaluation across four complementary dimensions: prior knowledge validation (TF markers, known TF-TF interactions, reference networks), genomic annotations (TF binding sites, cis-regulatory elements, chromatin-gene links), predictive performance (pathway enrichment, expression correlation), and mechanistic validation (perturbation forecasting, Boolean network simulations). The package includes built-in GRN inference methods, curated benchmark datasets, and visualization tools to facilitate rigorous comparison of network inference approaches.
29+
`gretapy` is a comprehensive framework for benchmarking and evaluating gene regulatory networks (GRNs) inferred from single-cell multiome (RNA+ATAC) data. It provides a systematic evaluation across four complementary dimensions: prior knowledge validation (TF markers, known TF-TF interactions, reference networks), genomic annotations (TF binding sites, cis-regulatory elements, chromatin-gene links), predictive performance (pathway enrichment, expression correlation), and mechanistic validation (perturbation forecasting, Boolean network simulations). The package includes built-in GRN inference methods, curated benchmark datasets, and visualization tools to facilitate rigorous comparison of network inference approaches.
3030

3131
## Getting started
3232

@@ -38,30 +38,30 @@ in particular, the [API documentation][].
3838
You need to have Python 3.11 or newer installed on your system.
3939
If you don't have Python installed, we recommend installing [uv][].
4040

41-
There are several alternative options to install pygreta:
41+
There are several alternative options to install gretapy:
4242

4343
1. Install the latest stable release from [PyPI][pypi] with minimal dependancies:
4444

4545
```bash
46-
pip install pygreta
46+
pip install gretapy
4747
```
4848

4949
2. Install the latest stable full release from [PyPI][pypi] with extra dependancies:
5050

5151
```bash
52-
pip install pygreta[full]
52+
pip install gretapy[full]
5353
```
5454

55-
3. Install the latest stable version from [conda-forge][conda] using mamba or conda (pay attention to the `-py` suffix at the end):
55+
3. Install the latest stable version from [conda-forge][conda] using mamba or conda:
5656

5757
```bash
58-
mamba create -n=dcp conda-forge::pygreta
58+
mamba create -n=greta conda-forge::gretapy
5959
```
6060

6161
4. Install the latest development version:
6262

6363
```bash
64-
pip install git+https://github.com/saezlab/pygreta.git@main
64+
pip install git+https://github.com/saezlab/gretapy.git@main
6565
```
6666

6767
## Release notes
@@ -79,12 +79,12 @@ If you found a bug, please use the [issue tracker][].
7979
8080
[uv]: https://github.com/astral-sh/uv
8181
[scverse discourse]: https://discourse.scverse.org/
82-
[issue tracker]: https://github.com/PauBadiaM/pygreta/issues
83-
[tests]: https://github.com/PauBadiaM/pygreta/actions/workflows/test.yaml
82+
[issue tracker]: https://github.com/saezlab/gretapy/issues
83+
[tests]: https://github.com/saezlab/gretapy/actions/workflows/test.yaml
8484
[documentation]: https://gretapy.readthedocs.io
85-
[changelog]: https://pygreta.readthedocs.io/en/latest/changelog.html
86-
[api documentation]: https://pygreta.readthedocs.io/en/latest/api.html
87-
[pypi]: https://pypi.org/project/pygreta
88-
[down]: https://pepy.tech/project/pygreta
89-
[conda]: https://anaconda.org/conda-forge/pygreta-py
90-
[codecoverage]: https://codecov.io/gh/saezlab/pygreta
85+
[changelog]: https://gretapy.readthedocs.io/en/latest/changelog.html
86+
[api documentation]: https://gretapy.readthedocs.io/en/latest/api.html
87+
[pypi]: https://pypi.org/project/gretapy
88+
[down]: https://pepy.tech/project/gretapy
89+
[conda]: https://anaconda.org/conda-forge/gretapy
90+
[codecoverage]: https://codecov.io/gh/saezlab/gretapy

docs/api/ds.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Functions for downloading and reading datasets and databases.
44

55
```{eval-rst}
6-
.. module:: pygreta.ds
7-
.. currentmodule:: pygreta.ds
6+
.. module:: gretapy.ds
7+
.. currentmodule:: gretapy.ds
88
99
.. autosummary::
1010
:toctree: generated

docs/api/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# API
22

3-
Import pygreta as:
3+
Import gretapy as:
44

55
```
6-
import pygreta as pg
6+
import gretapy as gt
77
```
88

99
## General Functions
1010

1111
```{eval-rst}
12-
.. module:: pygreta
13-
.. currentmodule:: pygreta
12+
.. module:: gretapy
13+
.. currentmodule:: gretapy
1414
1515
.. autosummary::
1616
:toctree: generated

docs/api/mt.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Methods for inferring gene regulatory networks.
44

55
```{eval-rst}
6-
.. module:: pygreta.mt
7-
.. currentmodule:: pygreta.mt
6+
.. module:: gretapy.mt
7+
.. currentmodule:: gretapy.mt
88
99
.. autosummary::
1010
:toctree: generated

docs/api/pl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Plotting functions for visualizing GRN analysis results.
44

55
```{eval-rst}
6-
.. module:: pygreta.pl
7-
.. currentmodule:: pygreta.pl
6+
.. module:: gretapy.pl
7+
.. currentmodule:: gretapy.pl
88
99
.. autosummary::
1010
:toctree: generated

docs/api/tl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Tools for benchmarking and analyzing gene regulatory networks.
55
## Benchmarking
66

77
```{eval-rst}
8-
.. module:: pygreta.tl
9-
.. currentmodule:: pygreta.tl
8+
.. module:: gretapy.tl
9+
.. currentmodule:: gretapy.tl
1010
1111
.. autosummary::
1212
:toctree: generated

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
# NOTE: If you installed your project in editable mode, this might be stale.
2323
# If this is the case, reinstall it to refresh the metadata
24-
info = metadata("pygreta")
24+
info = metadata("gretapy")
2525
project = info["Name"]
2626
author = info["Author"]
2727
copyright = f"{datetime.now():%Y}, {author}."

pyproject.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ build-backend = "hatchling.build"
33
requires = [ "hatchling" ]
44

55
[project]
6-
name = "pygreta"
6+
name = "gretapy"
77
version = "0.0.1"
88
description = "Package to evaluate gene regulatory networks (GRNs)."
99
readme = "README.md"
@@ -31,9 +31,9 @@ dependencies = [
3131
"session-info2",
3232
]
3333
# https://docs.pypi.org/project_metadata/#project-urls
34-
urls.Documentation = "https://pygreta.readthedocs.io/"
35-
urls.Homepage = "https://github.com/PauBadiaM/pygreta"
36-
urls.Source = "https://github.com/PauBadiaM/pygreta"
34+
urls.Documentation = "https://gretapy.readthedocs.io/"
35+
urls.Homepage = "https://github.com/PauBadiaM/gretapy"
36+
urls.Source = "https://github.com/PauBadiaM/gretapy"
3737

3838
[dependency-groups]
3939
dev = [
@@ -138,7 +138,7 @@ addopts = [
138138
]
139139

140140
[tool.coverage.run]
141-
source = [ "pygreta" ]
141+
source = [ "gretapy" ]
142142
patch = [ "subprocess" ]
143143
omit = [
144144
"**/test_*.py",

0 commit comments

Comments
 (0)