Skip to main content

A python script to convert any ase input file to gulp (.gin)

Project description

Gulp Input Setter

A simple Python module for creating GULP input files from CIF structures.

Installation

The installation is very straightforward. Follow the steps below.

Dependencies

The only dependency is:

  • ase (Atomic Simulation Environment)

Install from PyPI

pip install gulp_setup

Install from GitHub

Step 1: Clone the repository

git clone https://github.com/bafgreat/gulp_setup.git

Step 2: Move into the folder

cd gulp_setup

Step 3: Install the package

pip install .

This command will install the gulp_setup Python package locally.

Usage

Create inputs from a folder of CIF files

Run the command below to create a GULP input file for each CIF file in a folder. Each file will be placed into a folder named after the prefix of the input file name.

gulp_setup_folder folder

Create a single input file

If you do not want to create individual folders for each input file, simply run:

gulp_setup_file input.cif

This command will create an input.gin file in the same folder. This is useful when you do not want to create multiple folders for each input file.

Lattice optimization

By default, GULP input files are created for constant volumes (lattice not optimized). If you want to optimize the lattices, add the -op conp argument after the name of the input file.

Example:

gulp_setup_file input.cif -op conp

This will trigger lattice optimization.

Running GULP

If you have GULP installed, you can simply run it as follows:

gulp < input.gin > input.got

or

~/src/gulp-6.0/Src/gulp < input.gin > input.got

Notes

The second example assumes you have compiled GULP into a folder called $HOME/src.

For more information about installing GULP, visit: Download GULP

You can also email me if you have trouble with your installation. I am not an expert but I may have some knowledge to guide you.

Enjoy gulping

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

gulp_setup-0.1.3.tar.gz (12.2 kB view details)

Uploaded Source

Built Distribution

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

gulp_setup-0.1.3-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file gulp_setup-0.1.3.tar.gz.

File metadata

  • Download URL: gulp_setup-0.1.3.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.9 Darwin/24.3.0

File hashes

Hashes for gulp_setup-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c0edb796ea0f57a608a3e96630948ff96977c2459afd3bb6f0ee5e5edfecd589
MD5 f33f73f10600db08662747a709a02c26
BLAKE2b-256 e74244ab84993ac2cbd5295e3763b07b3a00ad49c5caada7578a417eeb4d2cf7

See more details on using hashes here.

File details

Details for the file gulp_setup-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: gulp_setup-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.9 Darwin/24.3.0

File hashes

Hashes for gulp_setup-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 117b03473758596f70c6aa13c5f16e7e5c3af84bbbf6d6a1aaf61a80c4aaef61
MD5 353520a8f4f03389cdb83410bcd7101c
BLAKE2b-256 2ee22615df4fd23037392a2758fca7e5806d1cd63f8894aca1de13e1ae9cf958

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