-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #411 from FAIRmat-NFDI/docs-for-cli-api
Add docs for CLI API, tool to report installed readers
- Loading branch information
Showing
7 changed files
with
72 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# API for command line tools | ||
|
||
`pynxtools` supports a number of command line applications. This page provides documentation for their current API. | ||
|
||
## Data conversion | ||
Note that simply calling `dataconverter` defaults to `dataconverter convert`. | ||
|
||
::: mkdocs-click | ||
:module: pynxtools.dataconverter.convert | ||
:command: main_cli | ||
:prog_name: dataconverter | ||
:depth: 2 | ||
:style: table | ||
:list_subcommands: True | ||
|
||
## NeXus file verification | ||
<!-- ::: mkdocs-click | ||
:module: "pynxtools.dataconverter.verify | ||
:command: verify_nexus | ||
:prog_name: verify_nexus | ||
:depth: 1 | ||
:style: table | ||
:list_subcommands: True --> | ||
|
||
::: mkdocs-click | ||
:module: pynxtools.nexus.nexus | ||
:command: main | ||
:prog_name: read_nexus | ||
:depth: 2 | ||
:style: table | ||
:list_subcommands: True | ||
|
||
## ELN generation | ||
::: mkdocs-click | ||
:module: pynxtools.eln_mapper.eln_mapper | ||
:command: get_eln | ||
:prog_name: generate_eln | ||
:depth: 1 | ||
:style: table | ||
:list_subcommands: True |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters