From e5579b59116c23e3f9f5010b6160ce4e65340524 Mon Sep 17 00:00:00 2001 From: Sherjeel Shabih Date: Mon, 20 Nov 2023 12:15:10 +0100 Subject: [PATCH] Updates README's to reflect removal of --merge-partial as a cli flag --- examples/json_map/README.md | 12 +++++++++++- pynxtools/dataconverter/README.md | 4 +--- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/examples/json_map/README.md b/examples/json_map/README.md index c98c6f77c..91b1a9559 100644 --- a/examples/json_map/README.md +++ b/examples/json_map/README.md @@ -7,11 +7,18 @@ This reader is designed to allow users of pynxtools to convert their existing da * JSON * Python Dict Objects Pickled with [pickle](https://docs.python.org/3/library/pickle.html). These can contain [xarray.DataArray](https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html) objects as well as regular Python types and Numpy types. +It accepts any NXDL file that you like as long as your mapping file contains all the fields. +Please use the --generate-template function of the dataconverter to create a .mapping.json file. + +```console +user@box:~$ python convert.py --nxdl NXmynxdl --generate-template > mynxdl.mapping.json +``` + ## How to run these examples? ### Automatically merge partial NeXus files ```console -user@box:~$ dataconverter --nxdl NXiv_temp --input-file voltage_and_temperature.nxs --input-file current.nxs --merge-partial --output auto_merged.nxs +user@box:~$ dataconverter --nxdl NXiv_temp --input-file voltage_and_temperature.nxs --input-file current.nxs --output auto_merged.nxs ``` ### Map and copy over data to new NeXus file @@ -23,3 +30,6 @@ user@box:~$ dataconverter --nxdl NXiv_temp --mapping merge_copied.mapping.json - ```console user@box:~$ dataconverter --nxdl NXiv_temp --mapping merge_linked.mapping.json --input-file voltage_and_temperature.nxs --input-file current.nxs --output merged_linked.nxs ``` + +## Contact person in FAIRmat for this reader +Sherjeel Shabih \ No newline at end of file diff --git a/pynxtools/dataconverter/README.md b/pynxtools/dataconverter/README.md index 8c5d27ebc..f8d600f41 100644 --- a/pynxtools/dataconverter/README.md +++ b/pynxtools/dataconverter/README.md @@ -37,8 +37,6 @@ Options: parameters the converter supports. --undocumented Shows a log output for all undocumented fields - --merge-partial Merges partial NeXus files provided as - different --input-file to the converter. --mapping TEXT Takes a .mapping.json file and converts data from given input files. --help Show this message and exit. @@ -47,7 +45,7 @@ Options: #### Merge partial NeXus files into one ```console -user@box:~$ dataconverter --nxdl nxdl --input-file partial1.nxs --input-file partial2.nxs --merge-partial +user@box:~$ dataconverter --nxdl nxdl --input-file partial1.nxs --input-file partial2.nxs ``` #### Map an HDF5/JSON/(Python Dict pickled in a pickle file)