File: cmdline.rst

package info (click to toggle)
python-ase 3.24.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 15,448 kB
  • sloc: python: 144,945; xml: 2,728; makefile: 113; javascript: 47
file content (89 lines) | stat: -rw-r--r-- 2,194 bytes parent folder | download | duplicates (3)
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
.. highlight:: bash

.. index:: command line tools

.. _cli:

=================
Command line tool
=================

ASE has a command line tool called :program:`ase` with the following
sub-commands:

==============  =================================================
sub-command     description
==============  =================================================
help            Help for sub-command
info            Print information about files or system
test            Test ASE
gui             ASE's :ref:`graphical user interface <ase-gui>`
convert         Convert between file formats (see :mod:`ase.io`)
reciprocal      Show the reciprocal space
find            Find files with atoms in
db              Manipulate and query :ref:`ASE database <ase-db>`
run             Run calculation with one of ASE's calculators
build           Build an atom, molecule or bulk structure
eos             Calculate equation of state
ulm             Show content of ulm-file
nomad-upload    Upload files to NOMAD
band-structure  Plot band-structure
nebplot         Analyze NEB trajectories
dimensionality  Analyze dimensionality of a structure
completion      Add tab-completion for Bash
==============  =================================================

.. note::

    The ase CLI interface is not quite stable.  Use with care in scripts!


Help
====

For all command-line tools, you can do::

    $ ase --help
    $ ase sub-command --help
    $ python -m module --help

to get help (or ``-h`` for short).


.. _bash completion:

Bash completion
===============

You can enable bash completion like this::

    $ ase completion >> ~/.bashrc

This will append a line like this::

    complete -o default -C "/path/to/python3 /path/to/ase/ase/cli/complete.py" ase

to your ``~/.bashrc``.


Python -m tricks
================

Some ASE modules can be invoked directly form the command line using ``python3
-m``.

:ref:`stylecheck`::

    $ python -m ase.utils.stylecheck source.py

:ref:`iso surface`::

    $ python -m ase.visulaize.mlab [options] filename

Convert old db-files to new::

    $ python -m ase.db.convert db-file

:ref:`convert`::

    $ python -m ase.io.pickletrajectory a1.traj [a2.traj ...]