Python quick reference¶

This page covers the calls used in the Python guides. It is a selected reference, not a complete generated API catalogue. The current declared surface lists the broader interface; signatures and behavior should be checked in the matching edi version.

Project input and output¶

Call or property	Purpose
`edi.Project.load(path)`	Open a complete project folder, its `project.edi`, or a zip.
`project.location`	Read the project's current location.
`project.save()`	Write the project to its current location.
`project.save_as(folder)`	Write a folder and continue working there.
`project.export_zip(path)`	Package the project's folder as last saved.

Model inspection¶

Property	Purpose
`project.structures`	Inspect the project's structures.
`project.experiments`	Inspect its experiments.
`project.free_parameters`	Inspect parameters whose `free` flag is set.
`parameter.value`	Read or change a parameter's value.
`parameter.free`	Read or change whether it may vary. Freeing a value a fit cannot vary raises an error with the reason.

Factories used here are StructureFactory.from_cif_path(path), ExperimentFactory.from_cif_path(path) and ExperimentFactory.from_data_path(...). These create model components, not automatically complete analysis projects. project.structures.add_from_cif_path(path) and project.experiments.add_from_cif_path(path) read a CIF or .edi file and add the result to the project; each reader also has a _str form that takes text.

Analysis¶

Call or property	Purpose
`project.analysis.calculate()`	Calculate from the current project; results stay on experiments.
`project.analysis.fit()`	Run the fit selected by the declared mode.
`project.analysis.fitting_mode`	Read or set `single`, `joint`, `sequential` or `independent`.
`project.analysis.descent`	Read or select a registered descent strategy.

Optional fit callbacks are on_start, on_iteration, on_scan_start, on_file_complete and should_cancel. Scan-specific callbacks require a scan-mode project.

Reports¶

Call	Purpose
`project.report.as_html(...)`	Obtain HTML text.
`project.report.save_html(path, ...)`	Write an HTML report.
`project.report.save(...)`	Write the selected formats except PDF, which the application writes.
`project.report.save_cif(path)`	Write a CIF report.
`project.report.check()`	Read saved-report freshness states.

See reports for call-specific options and the difference between saved settings and per-call overrides.