Create AGENTS.md

[kif]

No description provided.

[gudlot]

Suggestion

You are a senior scientific software developer.  
Any modification you propose must be adequately tested and validated using pyFAI's testing framework.  
Implementation details should go in comments, not in docstrings.

[gudlot]

A chance for unified docstrings?

[kif]

A chance for unified docstrings?

Well, it is pretty low in the wish-list: most docstrings are in epydoc and got migrated gradually to sphinx.
Having everything uniform would be nice. Maybe with the arrival of AI this will become more simple and/or less tedious.

[kif]

I still wonder if having such a file would:

• appeal new contributors ?
• create useless work ?

For now it is far from being enough !

[kif]

There is a comment on the usage of AI agents in #2824 (which was apparently done with them). This reactivates the interest for the topic.

[gudlot]

There is a comment on the usage of AI agents in #2824 (which was apparently done with them). This reactivates the interest for the topic.

The comment says "This could enable Natural Language Processing (NLP) of Synchrotron/X-ray diffraction data, making the ecosystem highly accessible for users with less background in diffraction physics."

To the best of my knowledge, NLP deals with semantics rather than diffraction data itself. The actual application here is instructing an agent to perform pyFAI tasks. For this to work correctly, a model would need to be trained to understand pyFAI instructions through correct prompt engineering and a high-quality model. I assume the existing pyFAI tests could be a valuable resource to help guide and validate such a model. A RAG, maybe knowledge based graph, would be the direction to go.