POSYDON-code / POSYDON-code/POSYDON

Documentation for post-processing pipeline needs to be clarified

Open
#567 1 comment 0 reactions 2 assignees View on GitHub

@elizabethteng is already working on this.

Since Apr 3, 2025.

documentation enhancement
Dominant language
Python
Stars
45
Forks
37
Avg merge
8d 20h
Merged PRs (30d)
5

Description

in consultation with @sgossage we've found that the pipeline steps page on the docs include outdated instructions, and that the most up-to-date practices are in fact reflected in the documentation of the ini file page.

I think we should restructure the post-processing section of the docs to remove anything that is deprecated and make it easier for a new user to identify what steps they should take.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.