Skip to content
Snippets Groups Projects
Commit fe4d2ca4 authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Add a brief description of customizations to the README

parent c0d0740d
Branches
Tags
1 merge request!1F awi sams
......@@ -29,6 +29,31 @@ instance's data model (e.g., by [synchronizing with the LinkAhead
advanced user
tools](https://docs.indiscale.com//caosdb-advanced-user-tools/yaml_interface.html)).
## Customization
The sample management module can be customized by overwriting
indivdual code and config files by using files of the same name and
with the same relative path in your LinkAhead profile's custom
directory. E.g., if you want to overwrite how sample entities are post-processed in the sample upload, you overwrite
```
sample-management-custom/caosdb-server/scripting/bin/sample_helpers/sample_upload_post_processing.py
```
from this repository by a
```
profile/custom/caosdb-server/scripting/bin/sample_helpers/sample_upload_post_processing.py
```
in your server profile. When doing so, it is important that in your
custom file, you use the exact same function names, signatures, and
return types as in the original file. In our example, the custom
`sample_upload_post_processing.py` needs to contain a
`post_process_samples` that takes the samples and the csv data as
arguments and returns the list of post processed samples.
## Testing
There is a pre-configured `test-profile` that you can use for testing
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment