Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Announce CNES/demcompare collaboration and update lead team background #640

Merged
merged 16 commits into from
Nov 15, 2024

Conversation

rhugonnet
Copy link
Member

@rhugonnet rhugonnet commented Nov 8, 2024

This PR updates the documentation to announce the collaboration and lead team change with demcompare.

A preview of the documentation generated on this branch can be found here: https://xdem-rhugonnet.readthedocs.io/en/doc_demcompare/

Specifically, this PR adds:

  • An announcement about the xDEM-demcompare collaboration on the "Where to start?" landing page,
  • A short description of who develops/uses xDEM on the "About xDEM" page, mentioning the joint lead from CNES + researchers,
  • A longer description and funding acknowledgments about the current leading team on the "Background" page (bottom).
  • Adds logos of CNES, SNSF and NASA on the last two pages, being the main funding sources behind xDEM!

TO-DO

  • Add all grant numbers to the funding sections,
  • Add light+dark logo versions to support both themes (NASA is the same; SNSF is available on their website, CNES not sure).

@rhugonnet rhugonnet changed the title Add announcement about merging efforts with demcompare in documentation Announce CNES/demcompare collaboration and update lead team background Nov 8, 2024
@rhugonnet
Copy link
Member Author

rhugonnet commented Nov 8, 2024

@duboise-cnes @adebardo @vschaffn This PR is ready for your review! There is a link in the PR description above to visualize the changes from this PR in the doc.
Feel free to propose edits or add new statements. I kept it short everywhere, but we could go into more details about the fusion plan, or CNES expertise in the "Background" page for instance. Just tell me what you think 😉.

(In addition to this PR) New documentation
Additionally, if you want, you can browse the new documentation (merged a couple days ago in #502; a big endeavor that started nearly 6 months ago) and note any remark you have! 🙂
The link above for this PR is up-to-date with the new doc so that works, or it is also available on the latest branch online: https://xdem.readthedocs.io/en/latest/ (the latest branch of the public documentation is not the default so not too visible yet, the default stable is still the old doc).
I merged it separately after Erik and Amaury's reviews so that this PR would be easier for you to browse, and because the tracked changes of the massive #502 PR weren't very useful for reviewing anyway (so much changed, and it's always good to re-read surrounding stuff when updating the doc).
So the best way to review is rather to browse the doc itself, page by page!

Short summary of changes to help you get an overview: The new doc separates scientific background content and code examples (moving and adding scientific content into guide pages in "Resources"), adds better links and plots to all feature pages, and adds some auxiliary pages for diverse uses based on user feedback (how to cite, method overview, cheatsheet for helping selecting a method, configuration, ecosystem, release notes, etc). It also improves the API listing, and adds a lot of streamlining/improvements for consistency, including for example a "Quick use" section at the start of each feature page, and tables summarizing available methods on most of those pages too.

And, with the new doc nearly finalized, we had in mind to follow up with the release a 0.1 (maybe once BlockwiseCoreg is fixed!).

@duboise-cnes
Copy link
Member

Thanks @rhugonnet . Perfect for me. Thanks for the add-on.

@rhugonnet
Copy link
Member Author

Perfect! Comments accounted for.
Merging this PR now for the addition, but don't hesitate to send comments on the new doc separately, if you have any!

@rhugonnet rhugonnet merged commit dc8c0f9 into GlacioHack:main Nov 15, 2024
19 checks passed
@rhugonnet rhugonnet deleted the doc_demcompare branch November 15, 2024 23:19
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