Contribute
Deposit data, use the API from your own code, or help with curation. This page is the path from reading the site to writing to it — a path the previous site left undocumented.
The three tiers
| Tier | Can | How to get it |
|---|---|---|
| — none — | Search and download everything. No account needed. | Nothing to do. |
| user | API tokens, saved searches, a persistent identity on deposits. | Register an account. |
| weaver | Deposit building blocks, structures, fragments and force-field parameters. Run assembly jobs. | Ask a maintainer, saying what you intend to deposit. It is granted per person, not per project. |
| admin | Curate: edit reference data, merge duplicates, review deposits. | By invitation from the maintainers. |
Why weaver is not self-service
A deposit becomes part of what everyone else downloads and cites. The
promotion is a short conversation about what you plan to add and under what
licence, not a form — and the tiers themselves are unchanged from the
previous system, so an existing weaver stays one.
Depositing data
-
Assign a force field to a structure
Get MOF-FF parameters for your own structure, and understand what came back.
-
Deploy the site
-
Deposit a building block
What to prepare, what the licence field means, and how to upload — for holders of the weaver tier.
-
Move to token authentication
Swap a password in ~/.mofplusrc for a scoped token, without breaking anything that already works.
-
Search nets by coordination sequence
Identify a net from numbers you computed yourself, from the browser or from a script.
Licensing your deposit
Every record carries its own licence, chosen at deposition and never empty. The default is CC BY 4.0; other terms are accepted where your institution or funder requires them.
| Identifier | Name |
|---|---|
| CC-BY-4.0 | Creative Commons Attribution 4.0 International |
| CC0-1.0 | Creative Commons Zero v1.0 Universal |
| CC-BY-SA-4.0 | Creative Commons Attribution-ShareAlike 4.0 International |
| CC-BY-NC-4.0 | Creative Commons Attribution-NonCommercial 4.0 International |
| RCSR-2019 | © 2019 RCSR.net — redistributed by MOF++ under agreement |
Using the API
The API has consumers outside this group, and existing installations keep
working: the XML-RPC endpoints and the /ff/ surface both still
answer, and ~/.mofplusrc is still read the way it always was.
New code should target the REST core.
-
API documentation
Interactive OpenAPI 3.1 description of every endpoint.
-
API reference
Three surfaces, one implementation — the REST core, the /ff/ client surface, and the deprecated XML-RPC adapter.
-
File formats
What .mfpx is, what you get in .json, and which format to ask for.
-
Glossary
The vocabulary this site uses, in the sense it uses it.
-
Python client
The mofplus package — what each class talks to, and what still works unchanged.
Sign in to mint an API token.