Learn
Documentation is split four ways by what you are trying to do right now: learn something, get a task done, look a fact up, or understand why the platform works the way it does. Mixing those is what makes documentation unusable.
Tutorials
Learning-oriented. Start here if MOFs or MOF++ are new to you.
How-to guides
Task-oriented. You know what you want; these say how.
-
For researchers
Assign a force field to a structure
Get MOF-FF parameters for your own structure, and understand what came back.
-
Deploy the site
-
For contributors
Deposit a building block
What to prepare, what the licence field means, and how to upload — for holders of the weaver tier.
-
For contributors
Move to token authentication
Swap a password in ~/.mofplusrc for a scoped token, without breaking anything that already works.
-
For researchers
Search nets by coordination sequence
Identify a net from numbers you computed yourself, from the browser or from a script.
Reference
Information-oriented. File formats, API, data model, vocabularies.
-
For contributors
API reference
Three surfaces, one implementation — the REST core, the /ff/ client surface, and the deprecated XML-RPC adapter.
-
For researchers
File formats
What .mfpx is, what you get in .json, and which format to ask for.
-
For newcomers
Glossary
The vocabulary this site uses, in the sense it uses it.
-
For researchers
Python client
The mofplus package — what each class talks to, and what still works unchanged.
Explanation
Understanding-oriented. Why the platform works the way it does.
-
For contributors
Access tiers, and why search is open
Three tiers, unchanged from the previous system, plus the one thing that deliberately needs no account at all.
-
For researchers
How force-field data is organised
Fragments, reference systems, fits and parameters — why a parameter is only meaningful with its fit.
-
For researchers
Identifiers and citation
Why every record gets a permanent URI but not its own DOI.
-
For newcomers
Nets, tilings and why topology matters
Why a database of abstract graphs is the useful thing to have when you are designing a real material.
-
For contributors
The data model
What the tables are, how they differ from the legacy schema, and what has not been migrated yet.
-
For researchers
The reverse topological approach
Designing a framework by starting from the net you want, rather than from the chemistry you have.
-
For contributors
The two orderings a net carries
rcsr_index is where a net is shown; complexity_rank is when it was ingested. They are different columns and conflating them is the known failure mode.
These pages are Markdown files in the site's repository. A correction is a pull request, and every change is reviewed and versioned — documentation is no longer edited live in production.