Skip to content

Commit

Permalink
updated the README with the JCIMpaper link (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
brje01 authored Aug 19, 2024
1 parent 8459bad commit 736d944
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# LWReg: a lightweight chemical registration system

The preprint of the application note describing `lwreg` is here: https://doi.org/10.26434/chemrxiv-2024-zrfl9

This provides a basic registration system which can be used either as a python
library or via a command-line interface.

Expand All @@ -11,6 +9,10 @@ Basic operations:
- `query`: takes a molecule as input and checks whether or not a matching molecule is registered. returns molregnos (registry IDs) of the matching molecule(s), if any
- `retrieve`: takes one or more IDs and returns the registered structures for them

## Publications

[1] J. Chem. Inf. Model. 2024, XXXX, XXX, XXX-XXX (ASAP article): https://pubs.acs.org/doi/10.1021/acs.jcim.4c01133

## Quick-start installation for non-experts:

Assuming that you have conda (or mamba or something equivalent) installed you can install lwreg directly from this github repo by first creating a conda environment with all the dependencies installed:
Expand Down

0 comments on commit 736d944

Please sign in to comment.