AGENTS.md for hep-data-llm package
Defines development environment, testing, and code style conventions for a Python package that uses LLMs to generate particle physics plots.
What this file does
Defines development environment, testing, and code style conventions for a Python package that uses LLMs to generate particle physics plots.
When to use it
- Starting a Python package with hatch, typer, and pydantic
- Setting up pytest with Docker and non-Docker test modes
- Establishing black and flake8 formatting rules for a project
- Organizing tests alongside source files in a Python project
Assumes this stack
AGENTS.md for hep-data-llm package
This is a proof of principle package for LLM's that can code up particle physics plots and other tasks.
Dev environment tips
- Run
pip install -e .[test]to get everything properly installed for testing and development. - Package uses
hatchto build the package. - Use
typerfor the CLI. Commands and sub commands are encouraged. - Use
pydanticobjects where it makes sense (reading config from files, etc.). - We are coding for python 3.13 and above. No need for things like
annotations.
Testing instructions
- Use
pytestto test all tests, andpytest --no-dockerif in an environment without docker. - Use
pytestfixtures when needed, including ones liketmp_pathto keep tests clean. - When adding new code make sure it is tested.
- Tests are located under the
testsdirectory, and each source file's test can be found intest_<source-file>.py. Always put new unit tests in the corresponding file of the code file you are testing. - Make sure
black .runs on all new code without changing it (e.g.blackformatting rules). You can ignore any errors in notebooks. - Make sure
flake8 src/andflake8 tests/also run. Line length is 99.
What's inside
1 dev environment tip, 1 testing section with 5 bullet points
Change this for your project
- Replace
pip install -e.[test]with your package's test extras - Replace
hep-data-llmwith your own package name - Replace
testsdirectory path if your tests live elsewhere
Where it goes
Save as AGENTS.md in your repository root. Read by Codex, Cursor and other agents that follow the AGENTS.md convention.
Related Documents
Browser-only development
Guides AI assistants on an Electron + React + TypeScript desktop app for browsing and organizing AI-generated images locally.
Claude Agents — Reference & Recommendations
Catalogues 40+ Claude agents and marketing skills for building a cat adoption charity landing page, with a ready-to-paste prompt and backend API reference.
Golden DKG Prototype -- Master Plan
Defines an 8-phase implementation plan for a Rust prototype of the Golden non-interactive DKG protocol using BLS12-381 and tokio.
Swarms Examples Index
Lists 60+ example scripts for building single and multi-agent systems with the Swarms framework, organized by category and use case.