Welcome to Kadi4Mat’s documentation!

Kadi4Mat, or Kadi for short, is a generic and open source virtual research environment. Originally developed in the context of materials science, Kadi4Mat can be used for the management of any type of research data within different research disciplines and use cases.

---

This documentation is mainly focused on the administration and development of and with Kadi4Mat. It contains instructions on how to install, maintain and configure Kadi4Mat, some general topics about developing or contributing to Kadi4Mat, information about the HTTP API Kadi4Mat provides as well as an overview and API reference of the source code itself.

For user-oriented information about Kadi4Mat, including a public demo instance, please see its website. The source code of the project can be found on GitLab.

---

Installation & Maintenance

• Production
• Development
• Configuration
• Plugins

This chapter contains instructions on how to install, maintain and configure Kadi4Mat as well as its plugins. For setting up Kadi4Mat as a service in a production environment, please refer to the production instructions. For development installations, please refer to the development instructions instead.

---

Development

• Project overview
• Useful tools
• Coding tips
• Testing
• Documentation
• Translations
• Plugins
• Common issues

This chapter covers various information about developing or contributing to Kadi4Mat. Before reading this chapter, make sure you have a working development environment.

---

HTTP API

• Introduction
• Endpoints

This chapter covers the HTTP API provided by Kadi4Mat, namely some introductory information as well as a list of all available API endpoints.

---

API reference

• Library
• Modules
• Plugin specs

This chapter serves as an API reference for the source code of Kadi4Mat, currently focused on the backend code.

---

Release history

• Release history
  • 1.0.1 (2024-10-02)
  • 1.0.0 (2024-09-24)
  • 0.52.0 (2024-07-24)
  • 0.51.0 (2024-07-01)
  • 0.50.0 (2024-05-27)
  • 0.49.0 (2024-04-22)
  • 0.48.0 (2024-04-02)
  • 0.47.0 (2024-02-29)
  • 0.46.0 (2024-02-26)
  • 0.45.3 (2024-02-06)
  • 0.45.2 (2024-01-29)
  • 0.45.1 (2024-01-29)
  • 0.45.0 (2024-01-24)
  • 0.44.1 (2023-12-15)
  • 0.44.0 (2023-12-11)
  • 0.43.1 (2023-11-28)
  • 0.43.0 (2023-11-27)
  • 0.42.0 (2023-10-24)
  • 0.41.0 (2023-09-25)
  • 0.40.0 (2023-08-29)
  • 0.39.3 (2023-07-28)
  • 0.39.2 (2023-07-27)
  • 0.39.1 (2023-07-26)
  • 0.39.0 (2023-07-25)
  • 0.38.0 (2023-07-12)
  • 0.37.1 (2023-06-26)
  • 0.37.0 (2023-06-26)
  • 0.36.0 (2023-05-30)
  • 0.35.0 (2023-04-24)
  • 0.34.0 (2023-04-01)
  • 0.33.0 (2023-02-27)
  • 0.32.0 (2023-02-01)
  • 0.31.1 (2023-01-09)
  • 0.31.0 (2022-12-17)
  • 0.30.1 (2022-11-29)
  • 0.30.0 (2022-11-28)
  • 0.29.1 (2022-10-27)
  • 0.29.0 (2022-10-25)
  • 0.28.1 (2022-10-02)
  • 0.28.0 (2022-09-26)
  • 0.27.1 (2022-08-23)
  • 0.27.0 (2022-08-23)
  • 0.26.0 (2022-07-12)
  • 0.25.1 (2022-06-07)
  • 0.25.0 (2022-06-07)
  • 0.24.1 (2022-05-04)
  • 0.24.0 (2022-04-27)
  • 0.23.1 (2022-03-23)
  • 0.23.0 (2022-03-23)
  • 0.22.0 (2022-02-16)
  • 0.21.1 (2022-01-13)
  • 0.21.0 (2022-01-13)
  • 0.20.0 (2021-12-06)
  • 0.19.0 (2021-11-22)
  • 0.18.1 (2021-10-18)
  • 0.18.0 (2021-10-18)
  • 0.17.0 (2021-09-13)
  • 0.16.0 (2021-07-26)
  • 0.15.1 (2021-06-28)
  • 0.15.0 (2021-06-25)
  • 0.14.0 (2021-06-07)
  • 0.13.0 (2021-05-20)
  • 0.12.0 (2021-04-23)
  • 0.11.0 (2021-04-14)
  • 0.10.0 (2021-04-02)
  • 0.9.0 (2021-03-24)
  • 0.8.1 (2021-03-17)
  • 0.8.0 (2021-03-16)
  • 0.7.1 (2021-03-11)
  • 0.7.0 (2021-03-10)
  • 0.6.0 (2021-02-05)
  • 0.5.0 (2021-01-13)
  • 0.4.3 (2020-12-07)
  • 0.4.2 (2020-12-07)
  • 0.4.1 (2020-12-04)
  • 0.4.0 (2020-12-03)
  • 0.3.0 (2020-11-10)
  • 0.2.0 (2020-10-02)
  • 0.1.2 (2020-09-22)
  • 0.1.1 (2020-09-15)
  • 0.1.0 (2020-09-14)