API Reference#

This reference is automatically generated from docstrings in the source code. It covers the main modules, classes, and functions available in the package.

Warning

This documentation is under active development and may be incomplete.

Core#

losalamos

{Short package description (1-3 sentences)} todo docstring

losalamos.root

A set of primitive classes used in other modules.

losalamos.project

Project management and filesystem initialization utilities.

Domain#

losalamos.notes

Utilities for managing structured Markdown notes.

losalamos.figures

SVG and raster figure handling for export pipelines.

losalamos.references

Reference management utilities for bibliographic metadata.

losalamos.ingestion

Automated ingestion utilities for bibliographic files.

Tools#

losalamos.tools.build_figures

Build image outputs from a folder of SVG files using a JSON parameter file.

losalamos.tools.ingest_references

Ingest reference files from a source directory into a target dataset structure.

losalamos.tools.search_references

Batch-extract bibliographic references from PDFs using a Gemini model.

losalamos.tools.update_references

Update reference notes in a target folder.

losalamos.tools.update_templates

Synchronise note templates to a target project folder.