Skip to content

Updated docs - #342

Open
rozyczko wants to merge 5 commits into
developfrom
updated-docs
Open

Updated docs#342
rozyczko wants to merge 5 commits into
developfrom
updated-docs

Conversation

@rozyczko

@rozyczko rozyczko commented Sep 1, 2026

Copy link
Copy Markdown
Member
  • The project roadmap is updated to mark magnetism and polarisation analysis as delivered, with references to new tutorials.

  • Adds detailed tutorials for magnetism (magnetism.md), polarised data (polarized_data.md), Bayesian analysis (bayesian.md), and demo datasets (datasets.md). These are linked from the main documentation index.

  • Updates the data loading tutorial to explain importing polarised experiments.

Installation and Demo Data:

  • Updates all installation instructions and links to reference the latest release (v1.4.0) and corrects the build platform descriptions for Linux installers.
  • Documents the included demo datasets and how to use them for learning constraint features.

Technical Clarifications:

  • Expands the docstring for the flatten function in structure.py to clarify the structure dictionary keys and their meanings.

@rozyczko rozyczko added [scope] documentation Documentation only changes (major.minor.patch-EXTENSION) [priority] high Should be prioritized soon labels Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[priority] high Should be prioritized soon [scope] documentation Documentation only changes (major.minor.patch-EXTENSION)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant