File tree 4 files changed +75
-1
lines changed
4 files changed +75
-1
lines changed Original file line number Diff line number Diff line change 1
- site /
1
+ site /
2
+ .idea
Original file line number Diff line number Diff line change
1
+ # Convert CIF to BinaryCIF
2
+ BinaryCIF is an efficient, binary flavor of the CIF format.
3
+
4
+ This script reads data in CIF format and converts it lossless to a BinaryCIF file that can be read by Mol* or other
5
+ applications.
6
+
7
+ ## Example
8
+ node lib/commonjs/cli/cif2bcif/index.js file.cif file.bcif
9
+
10
+ ## Usage
11
+ | Argument | Description |
12
+ | --- | --- |
13
+ | ` src ` | Source CIF to convert (can be gzipped) |
14
+ | ` out ` | Generated BinaryCIF output path |
15
+ | ` -c ` | Path to optional config file |
16
+ | ` -f ` | Path to optional filter file |
17
+
18
+ index.js [-h] [-c CONFIG] [-f FILTER] src out
19
+
20
+ ### Config file
21
+ Controls how certain columns will be encoded. This is a JSON array of instructions:
22
+ ``` ts
23
+ interface EncodingStrategyHint {
24
+ categoryName: string ,
25
+ columnName: string ,
26
+ encoding: ' pack' | ' rle' | ' delta' | ' delta-rle' ,
27
+ precision? : number
28
+ }
29
+ ```
30
+ Identify a particular CIF columns by its name and override the encoding by Integer Packing, Run-Length Encoding, Delta
31
+ Encoding, or Delta & Run-Length Encoding. You can optionally control the precision if dealing with float values.
32
+
33
+ ### Filter file
34
+ Specifies which categories and columns will be written. This is a plain text file, each line represents one entry.
35
+ You can specify explicitly which categories or columns to include by adding ` category_name ` or
36
+ ` category_name.field_name ` . You can also choose to ignore some categories or columns by adding ` !category_name ` or
37
+ ` !category_name.field_name ` .
Original file line number Diff line number Diff line change
1
+ # Create table from CCD
2
+ The [ Chemical Component Dictionary (CCD)] ( https://www.wwpdb.org/data/ccd ) is as an external reference file describing all residue and small molecule
3
+ components found in PDB entries. The Protonation Variants Companion Dictionary (PVCD) enumerates protonation variants of
4
+ canonical amino acids.
5
+
6
+ This script bundles all ` chem_comp_bond ` information from the CCD and the PVCD into a single file for later use.
7
+ Optionally, it can also generate a second output file that contains all ` chem_comp_atom ` information.
8
+
9
+ ## Example
10
+ node --max-old-space-size=4096 lib/commonjs/cli/chem-comp-dict/create-table.js build/data/ccb.bcif -b
11
+
12
+ ## Usage
13
+ | Argument | Description |
14
+ | --- | --- |
15
+ | ` out ` | Generated file output path |
16
+ | ` --forceDownload ` , ` -f ` | Force download of CCD and PVCD |
17
+ | ` --binary ` , ` -b ` | Output as BinaryCIF |
18
+ | ` --ccaOut ` , ` -a ` | File output path of optionally generated chem_comp_atom |
19
+
20
+ create-table.js [-h] [--forceDownload] [--binary] [--ccaOut CCAOUT] out
Original file line number Diff line number Diff line change
1
+ # Extract ions from CCD
2
+ The [ Chemical Component Dictionary (CCD)] ( https://www.wwpdb.org/data/ccd ) is as an external reference file describing all residue and small molecule
3
+ components found in PDB entries.
4
+
5
+ This script extracts all ions from the CCD and provides their names as TypeScript set.
6
+
7
+ ## Example
8
+ node --max-old-space-size=4096 lib/commonjs/cli/chem-comp-dict/create-ions.js src/mol-model/structure/model/types/ions.ts
9
+
10
+ ## Usage
11
+ | Argument | Description |
12
+ | --- | --- |
13
+ | ` out ` | Generated file output path |
14
+ | ` --forceDownload ` , ` -f ` | Force download of CCD |
15
+
16
+ create-ions.js [-h] [--forceDownload] out
You can’t perform that action at this time.
0 commit comments