Skip to content

Release version 1.0.0#139

Merged
heylf merged 460 commits into
masterfrom
dev
Jun 17, 2026
Merged

Release version 1.0.0#139
heylf merged 460 commits into
masterfrom
dev

Conversation

@heylf

@heylf heylf commented Apr 28, 2026

Copy link
Copy Markdown
Collaborator

The first release version of spatialxe. During the developemnt many tools were debugged, and new tools were added.
Since it is a first release thorough review is required.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs- [ ] If necessary, also make a PR on the nf-core/spatialxe branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

khersameesh24 and others added 30 commits September 9, 2025 21:32
Important! Template update for nf-core/tools v3.3.2
Massive linting fixes and other minor changes
Added new module and subworkflow for opt, Ci fix changes
Multisample support for spatialxe runs
Testing changes and code formatting
@heylf

heylf commented May 28, 2026

Copy link
Copy Markdown
Collaborator Author

Renaming of the pipeline is complete

an-altosian added a commit to an-altosian/spatialaxe that referenced this pull request May 28, 2026
Bug 2 from the Atera compatibility report: 19 modules using

    python3 ${moduleDir}/templates/<script>.py

fail on Tower / AWS Batch with

    python3: can't open file '/.nextflow/assets/an-altosian/spatialaxe/modules/local/<x>/templates/<script>.py': [Errno 2] No such file or directory

because ${moduleDir} interpolates the head-node path into .command.sh,
but the templates aren't staged at that absolute path on AWS Batch
workers. The path resolves to /.nextflow/... (leading slash) because
HOME is empty inside the worker container.

This regressed in PR nf-core#154 (commits 4f21dd2 -> ea46ad0 -> dbd7a35) which
moved the scripts from bin/ into per-module templates/ folders to
satisfy PR nf-core#139's no-module-level-bin review. The follow-up dbd7a35
switched from the 'template <file>.py' directive (which broke eval() in
non-Bash interpreters) to the shell-call invocation above -- which
works in local nf-test but breaks on Tower.

Fix: move the 20 scripts from modules/local/<x>/templates/ back to the
top-level bin/ directory, and invoke them by name. Nextflow auto-adds
bin/ to PATH on workers, so this works on Tower (and matches the
nf-core canonical pattern used by most pipelines). PR nf-core#139's review was
specifically about MODULE-level bin (modules/local/<x>/bin/) -- top-level
bin/ remains permissible.

Also cleans up 3 pre-existing unused imports in spatialdata_{merge,meta,write}.py
that ruff flagged once the scripts moved into the linted bin/ path.

Affected (19 modules, 20 scripts):
  - baysor/{create_dataset,preprocess}
  - ficture/preprocess
  - segger/{create_dataset,predict}
  - spatialdata/{merge,meta,write}
  - utility/{convert_mask_uint32,downscale_morphology,extract_dapi,
             extract_preview_data,get_coordinates,parquet_to_csv,
             resize_tif,segger2xr,split_transcripts,upscale_mask}
  - xenium_patch/stitch (2 scripts: stitch_transcripts + stitch_postprocess)

The orphaned pre-refactor bin/stitch_transcripts.py is overwritten by
the canonical templates/ version (sopa-based solve_conflicts() impl).

@awgymer awgymer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Do these need to be changed:

docs/images/spatialaxe-logo.svg:10:   sodipodi:docname="spatialxe-logo.svg"
docs/images/spatialaxe-logo.svg:12:   inkscape:export-filename="spatialxe-logo.png"
docs/images/spatialaxe-metromap.svg:12:   sodipodi:docname="spatialxe-metromap.svg"
docs/images/spatialaxe-metromap.svg:13:   inkscape:export-filename="spatialxe-metromap.png"

@heylf

heylf commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator Author

Fixed the issues commented before

@awgymer

awgymer commented Jun 15, 2026

Copy link
Copy Markdown

You still need a 2nd approving review from someone else who hasn't worked on the code.

@kubranarci kubranarci left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I see that in many of the local modules and subworkflows, the topic migration is done for main.nf yet meta.yml is not updated accordingly.

Comment thread assets/samplesheet.csv Outdated
Comment thread assets/schema_input.json
Comment thread modules/local/baysor/create_dataset/main.nf Outdated
Comment thread modules/local/baysor/preprocess/main.nf
Comment thread modules/local/baysor/run/meta.yml Outdated
Comment thread modules/local/segger/train/meta.yml Outdated
Comment thread subworkflows/local/baysor_generate_preview/main.nf
Comment thread subworkflows/local/baysor_generate_preview/meta.yml Outdated
Comment thread subworkflows/local/baysor_generate_segfree/meta.yml Outdated
Comment thread subworkflows/local/baysor_run_prior_segmentation_mask/meta.yml Outdated

@kubranarci kubranarci left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Congrats over your first release!

@heylf heylf merged commit 494cf02 into master Jun 17, 2026
57 checks passed
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.

7 participants