upf 0.1.1

Rust library for reading UPF text into typed structs and writing validated UpfData back to UPF
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

# Unified Pseudopotential Format

[![CI](https://github.com/ShapelessCat/upf/actions/workflows/ci.yml/badge.svg)](https://github.com/ShapelessCat/upf/actions/workflows/ci.yml)
[![Crates.io](https://img.shields.io/crates/v/upf.svg)](https://crates.io/crates/upf)
[![Documentation](https://docs.rs/upf/badge.svg)](https://docs.rs/upf)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

The Unified Pseudopotential Format (UPF) specification is here:
<https://pseudopotentials.quantum-espresso.org/home/unified-pseudopotential-format>.

This repository provides a Rust library that reads Unified Pseudopotential
Format (UPF) text files into typed Rust structs and writes validated
`UpfData` values back to UPF text, enabling semantic round-trips between file
content and Rust data.

Project documentation:

- [Project guide](docs/PROJECT.md)
- [API documentation on docs.rs](https://docs.rs/upf)
- [Bundled UPF reference](docs/reference/upf-spec.html)

Local verification:

- `cargo fmt --check`
- `cargo clippy --all-targets -- -D warnings`
- `cargo test`
- `cargo doc --no-deps`

Core API:

- `upf::from_str`
- `upf::from_reader`
- `upf::from_file`
- `upf::to_string`
- `upf::to_writer`
- `upf::to_file`