Skip to main content

Collection of routines for applying the Ruhr University Neural Network energy representation (RuNNer).

Project description

runnerase-workflows

High-level workflows and command-line entry points built on top of the other runnerase packages — for users who want a ready-made procedure rather than assembling one from runnerase-core/runnerase-prediction/runnerase-training primitives.

Provides

  • ActiveLearning, DisagreementFunctions, Settings: active-learning loop for iteratively improving a potential based on prediction disagreement.
  • RuNNer-LAMMPS interface helpers (setup_runner_context, run_md, execute_runner_simulation, format_cmd_pair_style, ...) for running MD simulations with RuNNer potentials in LAMMPS.
  • prepare_prediction_from_trained_potential: set up a prediction run from an already-trained potential.
  • open_ovito: visualize structures and trajectories with OVITO (requires the optional ovito extra).

Command-line tools

This package also installs several CLI entry points:

  • active-learning
  • dataset-reduction
  • prepare_prediction_from_trained_potential
  • enforce-total-charge
  • open_ovito
  • prune_feature_maps

Installation

uv pip install runnerase-workflows
# with OVITO visualization support:
uv pip install "runnerase-workflows[ovito]"

Documentation

Tutorials on active learning, structure visualization, and LAMMPS-based simulations: https://runner.theochem2.rub.de/runnerase-docs/latest/

License

GPL-3.0-or-later. Part of the runnerase project.

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

runnerase_workflows-0.3.1.tar.gz (37.7 kB view details)

Uploaded Source

Built Distribution

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

runnerase_workflows-0.3.1-py3-none-any.whl (47.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runnerase_workflows-0.3.1.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.25 {"installer":{"name":"uv","version":"0.9.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Rocky Linux","version":"9.8","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runnerase_workflows-0.3.1.tar.gz
Algorithm Hash digest
SHA256 7ce98d78173e268c36c2cb268d75a7607bf973082e913f04bb892207d9fa521b
MD5 6c63ab013988d9b4fd314e6a1ff5f338
BLAKE2b-256 132d20615a2fa2a0b7f8516e4a13ec841826f1034ce279ea7ff36494a218822c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: runnerase_workflows-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 47.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.25 {"installer":{"name":"uv","version":"0.9.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Rocky Linux","version":"9.8","id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for runnerase_workflows-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8219003459674af871d584f67dbc776564d0ba636f38ac0cd7b77f7433a662a7
MD5 20e6a31c93137d8d1a89ac8fd530c974
BLAKE2b-256 b8e36582c260e554f777eb1ceaff412772062c34aca4cae0c8afa921cdb72ddf

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