Skip to content

Commit be30661

Browse files
authored
docs: small tweaks to better reflect actual intentions (#53)
1 parent ea91f38 commit be30661

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

docs/source/policies_practices/pipeline_development.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All processing pipelines that create derived assets should upgrade the [data_des
1616

1717
##### How to upgrade a data_description
1818

19-
Use the [`DataDescription.from_data_description()`](https://github.com/AllenNeuralDynamics/aind-data-schema/blob/e172cb06a63b722eaeaaf8933d0a17cbedf3feea/src/aind_data_schema/core/data_description.py#L334) function to create derived data_description objects. Pass the process name as a parameter, often just `"processed"`. If more source data assets were used than just the one being passed into the function then pass the optional `source_data` parameter as well with the names of those data assets.
19+
Use the [`DataDescription.from_data_description()`](https://github.com/AllenNeuralDynamics/aind-data-schema/blob/e172cb06a63b722eaeaaf8933d0a17cbedf3feea/src/aind_data_schema/core/data_description.py#L334) function to create derived data_description objects. Pass the process name as a parameter, often just `process_name="processed"`. If more source data assets were used than just the one being passed into the function then pass the optional `source_data` parameter as well with the names of those data assets.
2020

2121
```python
2222
from pathlib import Path
@@ -27,7 +27,7 @@ original_data_description = DataDescription.model_validate_json(
2727
Path("data_description.json").read_text()
2828
)
2929

30-
# Create a derived data_description with upgrade
30+
# Upgrade to the new derived data_description
3131
derived_data_description = DataDescription.from_data_description(
3232
data_description=original_data_description,
3333
process_name="processed"
@@ -45,5 +45,4 @@ If processing was performed as part of a nextflow pipeline, that should be track
4545

4646
#### Other metadata
4747

48-
Metadata `.json` files that are not modified should be copied to the derived asset unchanged.
49-
48+
Core metadata `.json` files that are not modified should be copied to the derived asset unchanged. If it's present, do not copy the `metadata.nd.json` file -- this file is synchronized by the indexer and should not be moved manually.

0 commit comments

Comments
 (0)