GitHub

This milestone tracks all development tasks related to stabilizing the new EasyDiffraction API and laying the groundwork for integration with EasyScience components.

The focus is on:

Finalizing and cleaning the new API
Improving test coverage and documentation
Setting up CI workflows and code quality tools
Planning future work through organized issues and milestones

Linked issues will cover:

Design and cleanup of the API
Testing (unit, functional, performance)
Docstrings and typing
Integration and structure of calculators
GitHub workflows and tooling
General developer experience improvements

Once complete, the API will be frozen and ready for safe extension.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

New API Stabilization

[EPIC] Short-Term Development Plan for EasyDiffraction

Refactor default constants: extend, use enums instead of strings, and move(?) into relevant classes

Implement single-crystal diffraction support (via Cryspy) to validate design for multiple sample_form experiment types

Assign physically meaningful min and max values to all parameters

Review and complete the description attribute for all parameters

Go through all <code>TODO</code> comments in the codebase and convert relevant ones into tracked issues.

Refactor the <code>SampleModel.add()</code> method: split into explicit methods to either add a <code>SampleModel</code> object or create a default one.

Refactor the <code>Experiment.add()</code> method: split into explicit methods to either add an <code>Experiment</code> object or create a default one.

Add a method to <code>Background</code> that accepts a list or NumPy array of background points or terms.

Review <code>_ordered_attrs</code>: either use it meaningfully or remove it and implement CIF attribute ordering another way.

Remove the <code>register_minimizer()</code> method from <code>CalculatorFactory</code>, or leave a placeholder with a <code>pass</code> statement and a comment noting future support for user-defined minimizers.

Investigate if <code>calculate_pattern()</code> returning <code>y_calc_total</code> is redundant, as it appears to be assigned directly to <code>experiment.datastore.pattern.calc</code> within the method.

Rename the <code>called_by_minimizer</code> argument in <code>calculate_pattern()</code> to something more descriptive, like <code>full_calculations</code>.

Move the <code>FitResults</code> class out of <code>minimizer_base.py</code> to a more appropriate module (e.g., <code>fitting</code>).

Implement a generic <code>Collection</code> base class to support both data blocks (e.g., <code>SampleModels</code>, <code>Experiments</code>) and loops (e.g., <code>Background</code>, <code>AtomSites</code>).

Create a generic <code>Summary</code> base class that can be moved to EasyScience.

Create a generic <code>Project</code> base class that can be moved to EasyScience.

Implement <code>model.show_calc_chart(sample_form="powder", beam_mode="constant wavelength", radiation_probe="neutron", range_min=10.0, range_max=150.0, range_inc=0.05)</code> as outlined in the ADR suggestion.

Move <code>load_measured_data</code> from <code>Datastore</code> to <code>Experiment</code> to ensure <code>Datastore</code> remains a pure storage component.

Redesign <code>Datastore</code> and extract a generic base class that can be reused in EasyScience.

Create a generic <code>BaseExperiment</code> base class suitable for EasyScience (excluding domain-specific elements like CIF).

Create a generic <code>Analysis</code> base class that can be moved to EasyScience.

Weight experiments relatively to each other during <code>joint</code> fit

New API Stabilization

List view