Skip to content

Add how-to page for using MADAS for data analytics#260

Open
kubanmar wants to merge 5 commits into
developfrom
howto_madas
Open

Add how-to page for using MADAS for data analytics#260
kubanmar wants to merge 5 commits into
developfrom
howto_madas

Conversation

@kubanmar
Copy link
Copy Markdown
Contributor

Adding a page that introduces MADAS for downloading data from NOMAD. It features a short introduction with two figures and links to the MADAS documentation and tutorials.

@kubanmar kubanmar requested a review from JFRudzinski March 25, 2026 09:53
@kubanmar kubanmar self-assigned this Mar 25, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 25, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://FAIRmat-NFDI.github.io/nomad-docs/pr-preview/pr-260/

Built to branch gh-pages at 2026-03-26 12:20 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@JFRudzinski JFRudzinski added the announcement Create an announcement on Discord for this PR label Mar 25, 2026
Copy link
Copy Markdown
Contributor

@JFRudzinski JFRudzinski left a comment

Choose a reason for hiding this comment

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

For me this is good as is. There are some questions in my head about long-term placement of external tools vs. native NOMAD functionality -- but I think this should not hold back the initial publishing of this page.

However, I would like to ask Laurie for a sign-off as well, please wait for him before merging

Comment thread docs/howto/manage/program/MADAS.md Outdated
@JFRudzinski JFRudzinski requested a review from lauri-codes March 25, 2026 20:21
Copy link
Copy Markdown
Contributor

@lauri-codes lauri-codes left a comment

Choose a reason for hiding this comment

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

I think this will make things more confusing for users.

MADAS is not an "official" FAIRmat product (does not live in the FAIRmat-NFDI organization and is not the default query tool we endorse), and thus it does not fit into our main docs. If we include it here, users will be confused even more by the abumdance of different query helper tools (we already have ArchiveQuery + workflow tool helpers).

A better approch to handling this would be to have a doc section that lists third-party NOMAD tools. There we can definitely have a a link + description of MADAS.

@kubanmar
Copy link
Copy Markdown
Contributor Author

That sounds like a valid concern. I can move the description to a new section. @JFRudzinski , where could that live?

For completeness, I would like to point out that MADAS is not a query tool, but a more complete framework for analyzing data.

@JFRudzinski
Copy link
Copy Markdown
Contributor

I agree, and I am starting to make some plans for docs refactoring ... but this will take some time still. We need to decide if we want to throw something up in the mean time. We could just put it under the Computational section for now. @kubanmar let's just discuss in person next week please

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

Labels

announcement Create an announcement on Discord for this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants