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.