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. For more information about the project, please see its website and documentation.
While the packaged code of Kadi4Mat can easily be installed as a Python package via pip, a complete installation requires a few additional dependencies and considerations. Please refer to the stable documentation for full installation instructions.
Contributions to the code are always welcome. However, please consider creating an issue first, as described below, if you are planning to make larger changes. Please refer to the latest documentation for instructions on how to set up a development environment of Kadi4Mat as well as other useful information, such as how to set up a separate fork of the main repository.
In order to merge any contributions back into the main repository, please open
a corresponding merge
request. Typically, the
source branch of the merge request would be a separate (feature) branch of your
forked repository containing the changes to merge, while the target branch
should correspond to the master branch of the main repository. Depending on
the changes, please make sure to add appropriate tests, documentation,
translations, etc. and also add a corresponding entry to the changelog in
HISTORY.md, if
necessary. Furthermore, you can add yourself as a contributor to
AUTHORS.md.
For any issues regarding Kadi4Mat (bugs, suggestions, discussions, etc.) please use the issue tracker of this project. Make sure to add one or more fitting labels to each issue in order to keep them organized. Before creating a new issue, please also check whether a similar issue is already open. Note that creating or interacting with issues requires a GitLab account.
For bugs in particular, please use the provided Bug
template
when creating a new issue, which also adds the Bug label to the issue
automatically. For security-related issues or concerns, please see
SECURITY.md.
FAQs
A generic and open source virtual research environment.
We found that kadi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
