X Tutup
Skip to content

Commit 99ab7b5

Browse files
authored
Add configuration section
1 parent fad6665 commit 99ab7b5

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

structure/installation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,25 @@ If you run
3636

3737
on your project, the BioJava dependencies will be automatically downloaded and installed for you.
3838

39+
### (Optional) Configuration
40+
41+
BioJava can be configured through several properties:
42+
43+
| Property | Description |
44+
| --- | --- |
45+
| `PDB_DIR` | Directory for caching structure files from the PDB. Mirrors the PDB's FTP server directory structure, with `PDB_DIR` equivalent to ftp://ftp.wwpdb.org/pub/pdb/. Default: temp directory |
46+
| `PDB_CACHE_DIR` | Cache directory for other files related to the structure package. Default: temp directory |
47+
48+
These can be set either as java properties or as environmental variables. For example:
49+
50+
```
51+
# This could be added to .bashrc
52+
export PDB_DIR=...
53+
# Or override for a particular execution
54+
java -DPDB_DIR=... -cp ...
55+
```
56+
57+
Note that your IDE may ignore `.bashrc` settings, but should have a preference for passing VM arguments.
3958

4059
<!--automatically generated footer-->
4160

0 commit comments

Comments
 (0)
X Tutup