Skip to content

Improve PEcAn.SIPNET README and documentation structure#3961

Open
sujalkurkute wants to merge 3 commits intoPecanProject:developfrom
sujalkurkute:feature/sipnet-readme-update
Open

Improve PEcAn.SIPNET README and documentation structure#3961
sujalkurkute wants to merge 3 commits intoPecanProject:developfrom
sujalkurkute:feature/sipnet-readme-update

Conversation

@sujalkurkute
Copy link
Copy Markdown

Description

This PR improves the PEcAn.SIPNET README to provide clearer, more structured, and user-friendly documentation.

Changes include:

  • Added a concise overview of SIPNET and its integration with PEcAn
  • Improved the "What is SIPNET?" section with clearer and more focused content
  • Added a "Using SIPNET via PEcAn" section with links to tutorials and documentation
  • Introduced a "Documentation Structure" section to clarify the relationship between README, SIPNET docs, and PEcAn documentation
  • Simplified installation instructions and removed redundant details
  • Replaced plain URLs with properly formatted Markdown links

Motivation and Context

The existing SIPNET documentation was fragmented and contained generic/template content. This update improves clarity, removes duplication, and provides better navigation between README, PEcAn documentation, and SIPNET standalone docs.

Fixes: #3703

Review Time Estimate

  • When possible

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I agree that PEcAn Project may distribute my contribution under any or all of
    • the same license as the existing code,
    • and/or the BSD 3-clause license.
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@omkarrr2533
Copy link
Copy Markdown
Contributor

Hey @sujalkurkute, welcome and thanks for the PR! 🙌

Just a heads up PR #3705 was already merged on March 7 and covered most of what's here (What is SIPNET, installation updates, demo links etc). Your changes might conflict with or revert some of that work.
Also worth knowing PR #3880 is still open and tackles the same issue more broadly.

The Documentation Structure section you added is a nice touch that isn't in either of those PRs though!

Would suggest rebasing on develop first and then seeing what still makes sense to keep. Happy to help if you have questions! 👍

@sujalkurkute
Copy link
Copy Markdown
Author

Thanks @omkarrr2533 for the feedback!

I’ll rebase my branch on develop and remove the duplicate changes that are already covered in PR #3705. I’ll keep and refine the documentation structure section.

Appreciate your guidance!

@sujalkurkute
Copy link
Copy Markdown
Author

Thanks for the feedback!

I have rebased my branch, removed the duplicate content, and kept only the documentation structure section. Please let me know if any further changes are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve PEcAn.SIPNET package/model documentation and connect PEcAn.SIPNET README to PEcAn book

2 participants