Skip to main content

Ctrl+K

GitHub
GitHub

Developers
Administrators
Users
What FairDM is for
FAIR data and research data infrastructure
The technology stack
The core data model
How sample and measurement types are stored
Controlled vocabularies
Configuration over code
Why complete metadata matters
How access to a record is decided
Why FairDM records contributors
How contributor accounts and credits work
How a profile is claimed
How FairDM configures a portal
Who is asked to agree to a legal document
How locations are stored and protected
Dataset publication, DOIs and DataCite metadata
Glossary
Framework Contributors
Architecture Decision Records
Roadmap — FairDM
Changelog

GitHub
GitHub

Section Navigation

Tutorial

Build your first sample and measurement types

How-to guides

How to add a factory for a portal model
How to add a filter to a sample type
How to add a measurement type
How to add a record field to a form
How to add a sample type
How to add a section to the home page
How to add a start step to a container
How to add a transform for another format
How to add a viewset to the API router
How to add an entry to the Manage menu
How to add an environment override module
How to add pages to a plugin
How to add queryset methods to a measurement type
How to add search and sort to a list view
How to allow only some sites to call the API
How to back up a portal
How to change a type’s API address
How to change how the team page looks
How to change the API rate limits
How to change the entrance layout
How to change the entrance pane
How to change the portal theme
How to change what a home page section shows
How to change what the edit details page offers
How to choose the fields the API returns
How to configure the agreement check
How to count API callers behind a proxy
How to create a ghost person
How to create a plugin
How to create an addon
How to credit a person on a record
How to customise a generated component
How to customise a sample form
How to customise the admin for a measurement type
How to customise the API documentation
How to customise the profile form
How to define a portal role of your own
How to deploy a portal in a container
How to develop a portal on the development image
How to extend an overview page
How to extend the profile-claiming flow
How to filter a list by a record
How to filter projects by vocabulary keywords
How to find records by where they are
How to give a sample or measurement a location
How to give a sample or measurement type its own overview page
How to grant object permissions on a polymorphic model
How to import and export locations
How to import people from a list of ORCID iDs
How to link to a legal document
How to load development data for the overview pages
How to loop over the registered types
How to narrow a record field by another field
How to override a FairDM setting
How to place an organization on a map
How to record sample relationships
How to register a sample or measurement type
How to render markdown in a template
How to restore a portal from a backup
How to restrict a plugin to some users
How to restrict a record field to one sample type
How to restrict API tokens to some people
How to run a background worker in a container
How to search a registered type by more than its name
How to show part of a page to a record’s team
How to sign in as each portal role while developing
How to sync a profile from ORCID or ROR without Celery
How to test a portal with FairDM factories
How to upgrade a portal to django-literature 0.3
How to upgrade a portal to vocabulary addresses
How to use a controlled vocabulary in a model
How to use a sample form in a view
How to write a custom form or filter for a measurement type

Reference

Base views
Components
Configuration
Container images
Contribution levels and record access
Contributor models
Core models
Crediting
Development accounts
Entrance pages
Form and filter mixins
Home page
Legal documents
Location fields
Management commands
Measurement model
Model configuration
Model fields
Overview page blocks
Overview plugins
Plugins
Portal roles in code
Profile claiming
Record editing pages
Record fields
REST API
Sample model
Settings
Template tags
Test factories
The registry
Python API
- fairdm

Explanation

How a measurement reports its value
How API callers are limited
How FairDM views are layered
How markdown is sanitised
How record fields decide what to offer
How the container images are versioned
What registering a type produces
Why factories create metadata only when asked

Developers
Python API
fairdm
fairdm.plugins

`fairdm.plugins`#

Re-export the plugin framework from fairdm.contrib.plugins.

Built with the PyData Sphinx Theme 0.21.0.

fairdm.plugins#

`fairdm.plugins`#