Skip to content

Update install doc with pipy info - #63

Merged
jpjarnoux merged 7 commits into
devfrom
doc/update_install_with_pipy
Oct 7, 2026
Merged

jpjarnoux merged 7 commits into
devfrom
doc/update_install_with_pipy

Conversation

@JeanMainguy

Copy link
Copy Markdown
Member

Description

Update installation docs to document the new PyPI package (panorama-sys) alongside the existing Bioconda install, following the PyPI release workflow added in #60.

Related issue

N/A

What changed

  • README.md: added PyPI badge, restructured "Quick Installation" into "Install with Bioconda" / "Install with PyPI" sections, added warning about missing non-Python dependencies (MMSeqs2, geckodriver) with PyPI install
  • docs/user/install.md: added "Installation via PyPI" section with the same warning

Testing

Docs-only change, no code impact.

Test environment:

  • Dataset used: N/A
  • Key parameters: N/A

Results:

  • Verified README and install.md render correctly

Documentation

  • Added/updated code comments
  • Added/updated docstring
  • Updated README or docs if needed
  • Added example usage (if relevant)

Checklist

  • My code follows the project guidelines
  • Complex logic is commented
  • No unnecessary files or debug code included
  • My PR is targeting the dev branch

Additional notes

jpjarnoux and others added 3 commits July 23, 2026 15:21
## Description

Release PR merging `dev` into `main`, bringing `main` from `1.0.0` up to
`1.0.4`. This covers several bug fixes (annotation timing, path
resolution, CLI argument names), a dependency floor bump for `pyhmmer`
(0.12.0, required for compatibility with its `bytes`→`str` API change),
removal of unsupported/dead CLI options, a large documentation overhaul
(developer guide, API reference, citation guide, quick-start), and CI
workflow cleanup.

## What changed

- **Fixes:**
- Fixed annotation monitoring accumulating elapsed time across
pangenomes instead of per-pangenome (#48).
- Fixed relative path resolution so `pangenome.h5` is found correctly
regardless of where the pangenome TSV/CLI is invoked from (#54).
- Fixed wrong argument names in the `compare_spots`/`compare_systems`
commands.
  - Fixed a CI failure (#49).
- **Dependencies:**
- Pinned `pyhmmer>=0.12.0` in `pyproject.toml` and `panorama.yml`;
updated `genInput.py`, `macsymodel_translator.py`, and `hmm_search.py`
to use plain `str` access on HMM/Hit/Sequence/Alignment attributes now
that pyhmmer 0.12+ returns `str` instead of `bytes` (#58).
- **Removed:**
- Removed unsupported `--conserved_spots` option from `write_flat.py`
(#56).
  - Removed the automatic version-bump GitHub Actions workflow (#52).
- **Utilities:**
- Added a `resolve_path` utility, integrated into `check_tsv_sanity` for
robust pangenome path resolution.
- **CI:**
- Scoped the Ruff format/lint workflow to `panorama`/`tests` only (`src`
input), so it no longer lints unrelated paths like `.github/scripts/`.
- Skipped test/Ruff workflow runs on `doc/*` branches and fixed
duplicate doc-check workflow runs.
- **Documentation:**
  - Added a "How to cite" guide and citation `.bib` files (#55).
  - Added a pull request template for contributions (#51).
- Large developer-guide and API-documentation restructuring: new I/O
layer and detection-workflow pages, cleaned-up autosummary/API
structure, removed several outdated developer docs.
- Numerous formatting/typo/link fixes across user and modeler
documentation; added PANORAMA logo and citation/paper badges to the
README.

## Testing

**Test environment:**

- Dataset used: no external `PANORAMA_test` dataset run as part of this
release PR itself — each underlying change was tested/verified
individually in its own PR (see #48, #49, #51, #52, #54, #55, #56, #57,
#58).
- Key parameters: N/A (aggregation PR).

**Results:**

- All constituent PRs passed CI (Ruff + pytest, Ubuntu/macOS, Python
3.12) individually before merging into `dev`.
- Recommend a final CI run on this PR against `main` before merging.

## Documentation

- [x] Added/updated code comments
- [x] Added/updated docstring
- [x] Updated README or docs if needed
- [ ] Added example usage (if relevant)

## Checklist

- [x] My code follows the project guidelines
- [x] Complex logic is commented
- [x] No unnecessary files or debug code included
- [ ] My PR is targeting the `dev` branch (this PR targets `main`, as a
release merge)

## Additional notes

`VERSION` is already at `1.0.4` on `dev` (bumped incrementally across
the merged PRs); no further manual bump should be needed for this
release. Anyone with an existing `panorama` conda env built before
`pyhmmer>=0.12.0` was pinned should recreate/update it to match the new
floor.
…to PyPI. (#60)

## Description

Add a GitHub Actions workflow to build and publish PANORAMA releases to
PyPI.

The `panorama` name is already taken on PyPI, so the package cannot be
published under this name. We therefore use `panorama-sys`, reflecting
PANORAMA's main feature: system detection.

The panorama-sys projects have already been created on both PyPI and
TestPyPI.

## What changed

* Added a GitHub Actions workflow to build and publish the package to
PyPI.
* Added optional manual publishing through `workflow_dispatch`:

  * Publish to TestPyPI for testing.
  * Publish to PyPI when needed.
* Releases are automatically published to PyPI when a GitHub release is
created.

Fixed how version is retrieved: use
`distribution("panorama-sys").version` instead of
`distribution("panorama").version`. This was call in main and in utils.
Refactor in a utils function `get_panorama_version` to hold only once
the logic.

## Testing

The workflow can be tested manually using `workflow_dispatch` and
selecting the appropriate publishing option.

## Documentation

Documentation and README updates will be handled in a second PR, once
PANORAMA is available on PyPI. This should make it easier to update the
installation instructions with the actual PyPI package.


## Additional notes

The workflow uses PyPI's trusted publishing mechanism, so no PyPI API
token is required.
@JeanMainguy JeanMainguy changed the title update doc with pipy info Update install doc with pipy info Sep 23, 2026
Comment thread docs/user/install.md Outdated
```

```{warning}
The PyPI package includes only the Python package and Python dependencies. It does not ship non-Python system requirements, such as MMSeqs2, geckodriver, or other OS-level tools that PANORAMA may need. Install those separately with your system package manager or Conda before using the full feature set.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we include the command or a link to the packages ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have this section https://panorama.readthedocs.io/latest/user/install.html#install-panorama-dependencies.

That might be good to refer to it and maybe update it.

@jpjarnoux
jpjarnoux changed the base branch from main to dev October 7, 2026 12:32
@jpjarnoux
jpjarnoux merged commit 6e9f4d7 into dev Oct 7, 2026
3 checks passed
@jpjarnoux
jpjarnoux deleted the doc/update_install_with_pipy branch October 7, 2026 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants