ria 0.2.0

An adapter for converting the RefractiveIndex.INFO database into a flat, key-value store.
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

# RIA: refractiveindex.info-adapters

[![docs.rs](https://img.shields.io/docsrs/ria)](https://docs.rs/ria/latest/lib_ria/)
[![Crates.io Version](https://img.shields.io/crates/v/ria)](https://crates.io/crates/ria)

Adapters to transform the refractiveindex.info database into single-file key/value stores.

`ria` provides two tools:

1. a Rust library containing the flattened `Store` datatype and methods for extracting the data, and
2. a command line tool to parse the [refractiveindex.info database](https://github.com/polyanskiy/refractiveindex.info-database) into a flat key/value store and write it to file.

## Quick start

### Install with Cargo

The CLI tool is an optional feature that can be installed from crates.io as

```console
cargo install ria --features cli
```

To install from this source code repository:

```console
cargo install --path . --features cli
```

### Create a single-file JSON store of the RefractiveIndex.info database

This assumes that you are currently inside the root folder of the refractiveindex.info-database repository. It will write a file called `results.dat` containing the data in JSON format.

```console
ria store
```

### Create a single-file bitcode store of the RefractiveIndex.info database

The database is in `refractiveindex.info-database/database`.

```console
ria -f bitcode store -p refractiveindex.info-database/database
```

### Validate a store

The file `results.dat` contains JSON data.

```console
ria -f json validate -i results.dat
```

### Get help

```console
ria --help
```

## Development

### Cloning this repository

Git provides two options to clone this repository, which contains the database as a submodule:

#### Recurse submodules

```console
# Assuming you're using SSH and not HTTPS

git clone --recurse-submodules git@github.com:kmdouglass/refractiveindex.info-adapters.git
```

#### Init and update

```console
# Assuming you're using SSH and not HTTPS

git clone git@github.com:kmdouglass/refractiveindex.info-adapters.git
cd refractiveindex.info-database
git submodule init
git submodule update
```

### Updating the database

```console
cd refractiveindex.info-database
git fetch
git merge origin/master
```

### Test and format

```console
cargo test --all-features
cargo fmt
```