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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
|
import json
import sys
from collections import defaultdict
from contextlib import contextmanager
from typing import Iterable, Iterator
import ase.io
from ase.db import connect
from ase.db.core import convert_str_to_int_float_or_str
from ase.db.row import row2dct
from ase.db.table import Table, all_columns
from ase.utils import plural
class CLICommand:
"""Manipulate and query ASE database.
Query is a comma-separated list of
selections where each selection is of the type "ID", "key" or
"key=value". Instead of "=", one can also use "<", "<=", ">=", ">"
and "!=" (these must be protected from the shell by using quotes).
Special keys:
* id
* user
* calculator
* age
* natoms
* energy
* magmom
* charge
Chemical symbols can also be used to select number of
specific atomic species (H, He, Li, ...). Selection examples:
calculator=nwchem
age<1d
natoms=1
user=alice
2.2<bandgap<4.1
Cu>=10
See also: https://wiki.fysik.dtu.dk/ase/ase/db/db.html.
"""
@staticmethod
def add_arguments(parser):
add = parser.add_argument
add('database', help='SQLite3 file, JSON file or postgres URL.')
add('query', nargs='*', help='Query string.')
add('-v', '--verbose', action='store_true', help='More output.')
add('-q', '--quiet', action='store_true', help='Less output.')
add('-n', '--count', action='store_true',
help='Count number of selected rows.')
add('-l', '--long', action='store_true',
help='Long description of selected row')
add('-i', '--insert-into', metavar='db-name',
help='Insert selected rows into another database.')
add('-a', '--add-from-file', metavar='filename',
help='Add configuration(s) from file. '
'If the file contains more than one configuration then you can '
'use the syntax filename@: to add all of them. Default is to '
'only add the last.')
add('-k', '--add-key-value-pairs', metavar='key1=val1,key2=val2,...',
help='Add key-value pairs to selected rows. Values must '
'be numbers or strings and keys must follow the same rules as '
'keywords.')
add('-L', '--limit', type=int, default=-1, metavar='N',
help='Show only first N rows. Use --limit=0 '
'to show all. Default is 20 rows when listing rows and no '
'limit when --insert-into is used.')
add('--offset', type=int, default=0, metavar='N',
help='Skip first N rows. By default, no rows are skipped')
add('--delete', action='store_true',
help='Delete selected rows.')
add('--delete-keys', metavar='key1,key2,...',
help='Delete keys for selected rows.')
add('-y', '--yes', action='store_true',
help='Say yes.')
add('--explain', action='store_true',
help='Explain query plan.')
add('-c', '--columns', metavar='col1,col2,...',
help='Specify columns to show. Precede the column specification '
'with a "+" in order to add columns to the default set of '
'columns. Precede by a "-" to remove columns. Use "++" for all.')
add('-s', '--sort', metavar='column', default='id',
help='Sort rows using "column". Use "column-" for a descending '
'sort. Default is to sort after id.')
add('--cut', type=int, default=35, help='Cut keywords and key-value '
'columns after CUT characters. Use --cut=0 to disable cutting. '
'Default is 35 characters')
add('-p', '--plot', metavar='x,y1,y2,...',
help='Example: "-p x,y": plot y row against x row. Use '
'"-p a:x,y" to make a plot for each value of a.')
add('--csv', action='store_true',
help='Write comma-separated-values file.')
add('-w', '--open-web-browser', action='store_true',
help='Open results in web-browser.')
add('--no-lock-file', action='store_true', help="Don't use lock-files")
add('--analyse', action='store_true',
help='Gathers statistics about tables and indices to help make '
'better query planning choices.')
add('-j', '--json', action='store_true',
help='Write json representation of selected row.')
add('-m', '--show-metadata', action='store_true',
help='Show metadata as json.')
add('--set-metadata', metavar='something.json',
help='Set metadata from a json file.')
add('--strip-data', action='store_true',
help='Strip data when using --insert-into.')
add('--progress-bar', action='store_true',
help='Show a progress bar when using --insert-into.')
add('--show-keys', action='store_true',
help='Show all keys.')
add('--show-values', metavar='key1,key2,...',
help='Show values for key(s).')
@staticmethod
def run(args):
main(args)
def count_keys(db, query):
keys = defaultdict(int)
for row in db.select(query):
for key in row._keys:
keys[key] += 1
n = max(len(key) for key in keys) + 1
for key, number in keys.items():
print('{:{}} {}'.format(key + ':', n, number))
return
def main(args):
verbosity = 1 - args.quiet + args.verbose
query = ','.join(args.query)
if args.sort.endswith('-'):
# Allow using "key-" instead of "-key" for reverse sorting
args.sort = '-' + args.sort[:-1]
if query.isdigit():
query = int(query)
add_key_value_pairs = {}
if args.add_key_value_pairs:
for pair in args.add_key_value_pairs.split(','):
key, value = pair.split('=')
add_key_value_pairs[key] = convert_str_to_int_float_or_str(value)
if args.delete_keys:
delete_keys = args.delete_keys.split(',')
else:
delete_keys = []
db = connect(args.database, use_lock_file=not args.no_lock_file)
def out(*args):
if verbosity > 0:
print(*args)
if args.analyse:
db.analyse()
return
if args.show_keys:
count_keys(db, query)
return
if args.show_values:
keys = args.show_values.split(',')
values = {key: defaultdict(int) for key in keys}
numbers = set()
for row in db.select(query):
kvp = row.key_value_pairs
for key in keys:
value = kvp.get(key)
if value is not None:
values[key][value] += 1
if not isinstance(value, str):
numbers.add(key)
n = max(len(key) for key in keys) + 1
for key in keys:
vals = values[key]
if key in numbers:
print('{:{}} [{}..{}]'
.format(key + ':', n, min(vals), max(vals)))
else:
print('{:{}} {}'
.format(key + ':', n,
', '.join('{}({})'.format(v, n)
for v, n in vals.items())))
return
if args.add_from_file:
filename = args.add_from_file
configs = ase.io.read(filename)
if not isinstance(configs, list):
configs = [configs]
for atoms in configs:
db.write(atoms, key_value_pairs=add_key_value_pairs)
out('Added ' + plural(len(configs), 'row'))
return
if args.count:
n = db.count(query)
print('%s' % plural(n, 'row'))
return
if args.insert_into:
if args.limit == -1:
args.limit = 0
progressbar = no_progressbar
length = None
if args.progress_bar:
# Try to import the one from click.
# People using ase.db will most likely have flask installed
# and therfore also click.
try:
from click import progressbar
except ImportError:
pass
else:
length = db.count(query)
nkvp = 0
nrows = 0
with connect(args.insert_into,
use_lock_file=not args.no_lock_file) as db2:
with progressbar(db.select(query,
sort=args.sort,
limit=args.limit,
offset=args.offset),
length=length) as rows:
for row in rows:
kvp = row.get('key_value_pairs', {})
nkvp -= len(kvp)
kvp.update(add_key_value_pairs)
nkvp += len(kvp)
if args.strip_data:
db2.write(row.toatoms(), **kvp)
else:
db2.write(row, data=row.get('data'), **kvp)
nrows += 1
out('Added %s (%s updated)' %
(plural(nkvp, 'key-value pair'),
plural(len(add_key_value_pairs) * nrows - nkvp, 'pair')))
out('Inserted %s' % plural(nrows, 'row'))
return
if args.limit == -1:
args.limit = 20
if args.explain:
for row in db.select(query, explain=True,
verbosity=verbosity,
limit=args.limit, offset=args.offset):
print(row['explain'])
return
if args.show_metadata:
print(json.dumps(db.metadata, sort_keys=True, indent=4))
return
if args.set_metadata:
with open(args.set_metadata) as fd:
db.metadata = json.load(fd)
return
if add_key_value_pairs or delete_keys:
ids = [row['id'] for row in db.select(query)]
M = 0
N = 0
with db:
for id in ids:
m, n = db.update(id, delete_keys=delete_keys,
**add_key_value_pairs)
M += m
N += n
out('Added %s (%s updated)' %
(plural(M, 'key-value pair'),
plural(len(add_key_value_pairs) * len(ids) - M, 'pair')))
out('Removed', plural(N, 'key-value pair'))
return
if args.delete:
ids = [row['id'] for row in db.select(query, include_data=False)]
if ids and not args.yes:
msg = 'Delete %s? (yes/No): ' % plural(len(ids), 'row')
if input(msg).lower() != 'yes':
return
db.delete(ids)
out('Deleted %s' % plural(len(ids), 'row'))
return
if args.plot:
if ':' in args.plot:
tags, keys = args.plot.split(':')
tags = tags.split(',')
else:
tags = []
keys = args.plot
keys = keys.split(',')
plots = defaultdict(list)
X = {}
labels = []
for row in db.select(query, sort=args.sort, include_data=False):
name = ','.join(str(row[tag]) for tag in tags)
x = row.get(keys[0])
if x is not None:
if isinstance(x, str):
if x not in X:
X[x] = len(X)
labels.append(x)
x = X[x]
plots[name].append([x] + [row.get(key) for key in keys[1:]])
import matplotlib.pyplot as plt
for name, plot in plots.items():
xyy = zip(*plot)
x = xyy[0]
for y, key in zip(xyy[1:], keys[1:]):
plt.plot(x, y, label=name + ':' + key)
if X:
plt.xticks(range(len(labels)), labels, rotation=90)
plt.legend()
plt.show()
return
if args.json:
row = db.get(query)
db2 = connect(sys.stdout, 'json', use_lock_file=False)
kvp = row.get('key_value_pairs', {})
db2.write(row, data=row.get('data'), **kvp)
return
if args.long:
row = db.get(query)
print(row2str(row))
return
if args.open_web_browser:
try:
import flask # noqa
except ImportError:
print('Please install Flask: python3 -m pip install flask')
return
check_jsmol()
import ase.db.app as app
app.add_project(db)
app.app.run(host='0.0.0.0', debug=True)
return
columns = list(all_columns)
c = args.columns
if c and c.startswith('++'):
keys = set()
for row in db.select(query,
limit=args.limit, offset=args.offset,
include_data=False):
keys.update(row._keys)
columns.extend(keys)
if c[2:3] == ',':
c = c[3:]
else:
c = ''
if c:
if c[0] == '+':
c = c[1:]
elif c[0] != '-':
columns = []
for col in c.split(','):
if col[0] == '-':
columns.remove(col[1:])
else:
columns.append(col.lstrip('+'))
table = Table(db, verbosity=verbosity, cut=args.cut)
table.select(query, columns, args.sort, args.limit, args.offset)
if args.csv:
table.write_csv()
else:
table.write(query)
def row2str(row) -> str:
t = row2dct(row)
S = [t['formula'] + ':',
'Unit cell in Ang:',
'axis|periodic| x| y| z|' +
' length| angle']
c = 1
fmt = (' {0}| {1}|{2[0]:>11}|{2[1]:>11}|{2[2]:>11}|' +
'{3:>10}|{4:>10}')
for p, axis, L, A in zip(row.pbc, t['cell'], t['lengths'], t['angles']):
S.append(fmt.format(c, [' no', 'yes'][p], axis, L, A))
c += 1
S.append('')
if 'stress' in t:
S += ['Stress tensor (xx, yy, zz, zy, zx, yx) in eV/Ang^3:',
' {}\n'.format(t['stress'])]
if 'dipole' in t:
S.append('Dipole moment in e*Ang: ({})\n'.format(t['dipole']))
if 'constraints' in t:
S.append('Constraints: {}\n'.format(t['constraints']))
if 'data' in t:
S.append('Data: {}\n'.format(t['data']))
width0 = max(max(len(row[0]) for row in t['table']), 3)
width1 = max(max(len(row[1]) for row in t['table']), 11)
S.append('{:{}} | {:{}} | Value'
.format('Key', width0, 'Description', width1))
for key, desc, value in t['table']:
S.append('{:{}} | {:{}} | {}'
.format(key, width0, desc, width1, value))
return '\n'.join(S)
@contextmanager
def no_progressbar(iterable: Iterable,
length: int = None) -> Iterator[Iterable]:
"""A do-nothing implementation."""
yield iterable
def check_jsmol():
from ase.db.app import root
static = root / 'ase/db/static'
if not (static / 'jsmol/JSmol.min.js').is_file():
print(f"""
WARNING:
You don't have jsmol on your system.
Download Jmol-*-binary.tar.gz from
https://sourceforge.net/projects/jmol/files/Jmol/,
extract jsmol.zip, unzip it and create a soft-link:
$ tar -xf Jmol-*-binary.tar.gz
$ unzip jmol-*/jsmol.zip
$ ln -s $PWD/jsmol {static}/jsmol
""",
file=sys.stderr)
|