From ca97adde4e2858e09090043229d7971161671ef4 Mon Sep 17 00:00:00 2001 From: singularitti Date: Mon, 3 Jul 2023 19:58:03 -0400 Subject: [PATCH] Fix all `jld2` extension to `jls` --- docs/src/run/cli.md | 8 ++++---- docs/src/run/configuration.md | 12 ++++++------ docs/src/troubleshooting.md | 8 ++++---- src/EquationOfStateWorkflow/Config.jl | 4 ++-- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/src/run/cli.md b/docs/src/run/cli.md index 40036578..9c59f4a2 100644 --- a/docs/src/run/cli.md +++ b/docs/src/run/cli.md @@ -42,16 +42,16 @@ To print either input or output data in a formatted, readable form, run xps print ``` -where the allowed extensions of `` are `.jld2`, `.json`, `.yaml` or `.yml`, and +where the allowed extensions of `` are `.jls`, `.json`, `.yaml` or `.yml`, and `.toml`. The last four extensions correspond to three human-readable data-serialization file formats, i.e., [JSON](https://www.json.org/json-en.html), [YAML](https://yaml.org/), and -[TOML](https://toml.io/en/), while `.jld2` is a binary serialization format only recognizable +[TOML](https://toml.io/en/), while `.jls` is a binary serialization format only recognizable to Julia. For example, ```shell xps print eos.toml xps print raw.json -xps print eos.jld2 +xps print eos.jls ``` `express` can also plot some data, such as the fitted EOS applied to a certain range of @@ -61,7 +61,7 @@ volumes along with the raw data. The corresponding command is xps plot ``` -where `` refers to the EOS binary file with extension `.jld2`. +where `` refers to the EOS binary file with extension `.jls`. These are the three most important commands of `express`. These catchy commands cover all the functionalities we diff --git a/docs/src/run/configuration.md b/docs/src/run/configuration.md index cbe3d44f..dd1a09c1 100644 --- a/docs/src/run/configuration.md +++ b/docs/src/run/configuration.md @@ -59,7 +59,7 @@ cli: np: 16 template: template.in save: - status: status.jld2 + status: status.jls fixed: pressures: unit: GPa @@ -92,7 +92,7 @@ The JSON and TOML equivalents of the above file are: }, "template": "template.in", "save": { - "status": "status.jld2" + "status": "status.jls" }, "fixed": { "pressures": { @@ -121,7 +121,7 @@ values = ['300.44 bohr^3', '74.88 GPa', 4.82] np = 16 [save] -status = 'status.jld2' +status = 'status.jls' ``` ## Phonon density of states or phonon dispersion relation @@ -174,7 +174,7 @@ template: q2r: q2r.in disp: disp.in save: - status: status.jld2 + status: status.jls fixed: pressures: unit: GPa @@ -206,7 +206,7 @@ The JSON and TOML equivalents of the above file are: "disp": "disp.in" }, "save": { - "status": "status.jld2" + "status": "status.jls" }, "fixed": { "pressures": { @@ -232,5 +232,5 @@ unit = 'GPa' values = [-5, -2, 0, 5, 10, 15, 17, 20] [save] -status = 'status.jld2' +status = 'status.jls' ``` diff --git a/docs/src/troubleshooting.md b/docs/src/troubleshooting.md index 2f2aa948..86d08d93 100644 --- a/docs/src/troubleshooting.md +++ b/docs/src/troubleshooting.md @@ -211,10 +211,10 @@ Check the value of the key `status` in the `save` dictionary in `workflow.yaml`: ```yaml save: - status: status.jld2 + status: status.jls ``` -Then delete the file `status.jld2` and retry running `run!(wf)`. +Then delete the file `status.jls` and retry running `run!(wf)`. ### Why does `buildworkflow` return the same `Workflow` object if I am starting a new workflow? @@ -235,10 +235,10 @@ in your configuration file (`phonon.yaml`). You probably have the following sett ```yaml save: - status: status.jld2 + status: status.jls ``` -where the `status.jld2` already exists and is the serialized `Workflow` object saved from +where the `status.jls` already exists and is the serialized `Workflow` object saved from the previous (equation of state) workflow. `Express.jl` will first load this file if it exists. To fix this, change the value of the `status` key to another path. diff --git a/src/EquationOfStateWorkflow/Config.jl b/src/EquationOfStateWorkflow/Config.jl index 8af93adc..e7adc865 100644 --- a/src/EquationOfStateWorkflow/Config.jl +++ b/src/EquationOfStateWorkflow/Config.jl @@ -46,8 +46,8 @@ end @option struct Save ev::String = "ev.json" - eos::String = "eos.jld2" - wf::String = "wf.jld2" + eos::String = "eos.jls" + wf::String = "wf.jls" end @option struct RuntimeConfig