Skip to content

Commit

Permalink
Fix all jld2 extension to jls
Browse files Browse the repository at this point in the history
  • Loading branch information
singularitti committed Jul 3, 2023
1 parent abcc582 commit ca97add
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions docs/src/run/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ To print either input or output data in a formatted, readable form, run
xps print <file-name>
```

where the allowed extensions of `<file-name>` are `.jld2`, `.json`, `.yaml` or `.yml`, and
where the allowed extensions of `<file-name>` 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
Expand All @@ -61,7 +61,7 @@ volumes along with the raw data. The corresponding command is
xps plot <file-name>
```

where `<file-name>` refers to the EOS binary file with extension `.jld2`.
where `<file-name>` 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
Expand Down
12 changes: 6 additions & 6 deletions docs/src/run/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ cli:
np: 16
template: template.in
save:
status: status.jld2
status: status.jls
fixed:
pressures:
unit: GPa
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -174,7 +174,7 @@ template:
q2r: q2r.in
disp: disp.in
save:
status: status.jld2
status: status.jls
fixed:
pressures:
unit: GPa
Expand Down Expand Up @@ -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": {
Expand All @@ -232,5 +232,5 @@ unit = 'GPa'
values = [-5, -2, 0, 5, 10, 15, 17, 20]

[save]
status = 'status.jld2'
status = 'status.jls'
```
8 changes: 4 additions & 4 deletions docs/src/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions src/EquationOfStateWorkflow/Config.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ca97add

Please sign in to comment.