Skip to main content

Create Martini force field templates for GROMACS

Project description

Martini Templates

Martini Templates is a Python package that provides a CLI for generating Martini MDP files with sensible defaults. It uses Jinja2 templates to create MDP files for molecular dynamics simulations, allowing users to customize parameters and generate files for different simulation types.

Features

  • Generate MDP files for NVT, NPT, and energy minimization simulations.
  • Override default values for reference temperature (ref_t) and pressure (ref_p).
  • Create all simulation files at once using the --all flag.
  • Customizable output filenames.

Installation

Ensure Python 3.10 or higher is installed, then install the package using:

pip install .

Usage

Run the CLI tool to generate MDP files:

martini-templates [options]

Options

  • --nvt: Generate an NVT file (20 ns, no pressure coupling).
  • --npt: Generate an NPT file (50 ns, pressure coupling).
  • --em: Generate an energy minimization file.
  • --all: Generate all files (NVT, NPT, EM).
  • --ref_t: Set the reference temperature (default: 298 K).
  • --ref_p: Set the reference pressure (default: 1 bar).
  • --output: Specify a custom output filename (overrides default naming).

Examples

Generate an NVT file with default settings:

martini-templates --nvt

Generate an NPT file with a custom temperature and pressure:

martini-templates --npt --ref_t 310 --ref_p 1.5

Generate all files:

martini-templates --all

Recommended Usage with uvx

For better CLI experience and command management, it is recommended to use uvx:

uvx martini-templates --nvt

License

This project is licensed under the MIT License.

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

martini_templates-0.1.0.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

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

martini_templates-0.1.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file martini_templates-0.1.0.tar.gz.

File metadata

  • Download URL: martini_templates-0.1.0.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.10

File hashes

Hashes for martini_templates-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fee30fbe84a67ee01c58f14565ad6c14f37ed56a38e78a52a83c94057c2ac489
MD5 e50032eaeaad5c1a38ad374e66150d43
BLAKE2b-256 da29bdfb963720447d45e09bfbc8bd81edd52064f8a360770a47ecc3c7a24867

See more details on using hashes here.

File details

Details for the file martini_templates-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for martini_templates-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 28b117fb72f4e4a5df3f14273586dd1465a531987a810a022cbc3f72a26cfd1b
MD5 200c3b337ceea0779249838a4fa69b6f
BLAKE2b-256 9423b9a6bdfd9d52b380d50d47fffbdcea63f8bdfd6ee0d0aecbb4cc6c4216fd

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