From 036df2f5a5c61e930c013f80125b7c11c8c770b6 Mon Sep 17 00:00:00 2001 From: Anthony Scemama Date: Tue, 24 Nov 2020 19:21:06 +0100 Subject: [PATCH] README --- README.md | 13 ------------- tools/README.md | 11 +++++++++++ 2 files changed, 11 insertions(+), 13 deletions(-) create mode 100644 tools/README.md diff --git a/README.md b/README.md index a8fa118e..280ac752 100644 --- a/README.md +++ b/README.md @@ -47,16 +47,3 @@ method with respect to various variables such as the molecule size or its family, the nature of the excited states, the size of the basis set, etc. -### The tools - -[tools](tools/) a series of python scripts used to generate data: - -- `datafileBuilder`: A python script to generate data from custom LaTeX input - file. See [examples](docs/examples). -- `metarecover`: A python script is used to regenerate the metadata from the - previous git history state. So you can remove a data file to regenerate it - from a LaTeX input file with `datafileBuilder` and recover the metadata - from the previous version using `metarecover`. -- `ADC25generator`: script used to build `ADC(2.5)` data files from `ADC(2)` and `ADC(3)` data files. -- `generate_data`: script used to wrap all data file into one `database.json` file. - diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 00000000..b0357bdf --- /dev/null +++ b/tools/README.md @@ -0,0 +1,11 @@ +This directory contains a series of Python scripts used to generate data: + +- `datafileBuilder`: A python script to generate data from custom LaTeX input + file. See [examples](docs/examples). +- `metarecover`: A python script is used to regenerate the metadata from the + previous git history state. So you can remove a data file to regenerate it + from a LaTeX input file with `datafileBuilder` and recover the metadata + from the previous version using `metarecover`. +- `ADC25generator`: script used to build `ADC(2.5)` data files from `ADC(2)` and `ADC(3)` data files. +- `generate_data`: script used to wrap all data file into one `database.json` file. +