Skip to main content

Textual user interface for ASE db.

Project description

texase

Texase is a TUI[^1] for ASE databases. It allows you to quickly get an overview, navigate and manipulate an ASE database.

[^1]: Textual User Interface (Also known as a Terminal/Text User Interface)

Built with Textual

PyPI - Version MPL License PyPI - Python Version GitHub Actions Workflow Status

Demo

Installation

Install texase with pip

pip install texase

Usage

After installation do texase file.db where file.db is your ASE database.

  • Press ? to view all keybindings

  • Navigation

Move the cursor with the arrow keys to select different rows and columns.

  • Press Space to mark a row.

Marking can be used with many subsequent action, e.g. view, export, add/remove key value pairs etc.

  • Filter (/) and search (Ctrl-s)

Show only rows based on a filter. Search for a certain string/regex, subsequent key presses on Ctrl-s moves the cursor to the next match.

  • Viewing (v)

Open the current row or all marked rows with ASE GUI.

  • Importing/Exporting trajectories/databases (i/x)

Import an external file to the database or save current or all marked rows to a file.

  • Add/remove/edit key value pairs (k/d/e)

Manipulate the key value pairs as much as you like. Mind that some key value pairs belonging to the Atoms object cannot be changed.

  • Press Enter and see and modify all the details of a row.

  • Adding/removing columns (+/-)

Remove the column of the current cursor with - and add columns not shown with +. Columns can also be added by clicking the corresponding key at the bottom of the screen. Chosen columns are saved between invocations of the same database.

  • Deleting rows (#)
  • Suspend the app (Ctrl-z)

This keeps the texase with the database loaded in memory and returns to the command line. The app can be brought back to focus with fg. It is possible to suspend more invocations of texase and selectively bring them to the foreground.

Background

I use the database in ASE a lot. The command line interface ase db could slow me down a bit though when I wanted to check out the results of some calculations and then view a structure or get some output in another way. I would normally go:

  • ase db file.db
  • ase db -L 0 file.db
  • ase db -s energy file.db
  • ase gui file.db@id=32

Now I can just do texase file.db and navigate with single key presses.

License

MPL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

texase-0.3.1.tar.gz (38.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

texase-0.3.1-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file texase-0.3.1.tar.gz.

File metadata

  • Download URL: texase-0.3.1.tar.gz
  • Upload date:
  • Size: 38.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.12

File hashes

Hashes for texase-0.3.1.tar.gz
Algorithm Hash digest
SHA256 a661a48585ff57ff9a3c084846a14a6ff71385d23bafc76ed5e64ee4947a2215
MD5 939b4ac31fb0f876ee7ca5821f9e9ae6
BLAKE2b-256 928bfe56adccf373a263250c36681e70c3efdcb2c0c725a6131a08a630bd8c8c

See more details on using hashes here.

File details

Details for the file texase-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: texase-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 46.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.12

File hashes

Hashes for texase-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 89d757c63d6b9235507644324f5cf2fafc37e2754e76487ffa6b46126087350f
MD5 71c1b3117e9a5808f01aaf46cc8f70dc
BLAKE2b-256 6177923958588e675164e016ad5cdd6962848ea6c099839bc85e5a53ed00abc4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page