Skip to content

Commit

Permalink
simple ini example in main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alchem0x2A committed Dec 1, 2024
1 parent 479752b commit 52c178c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,22 @@ Install the pre-compiled SPARC binary alongside SPARC-X-API (Linux only).
conda install -c conda-forge sparc-x
```

### Setup SPARC-X-API

Preferences for SPARC-X-API and SPARC C/C++ code can be defined in ASE [configuration file](https://wiki.fysik.dtu.dk/ase/ase/calculators/calculators.html#calculator-configuration), located at `~/.config/ase/config.ini`, such as following example:

```ini
[sparc]
; `command`: full shell command (include MPI directives) to run SPARC
command = srun -n 24 path/to/sparc

; `pp_path`: directory containing pseudopotential files (optional)
pp_path = path/to/SPARC/psps

; `doc_path`: directory for SPARC LaTeX documentation to build JSON schema on the fly (optional)
doc_path = path/to/SPARC/doc/.LaTeX/
```

### Reading / Writing SPARC files

SPARC-X-API provides a file format `sparc` compatible with the ASE
Expand Down

0 comments on commit 52c178c

Please sign in to comment.