https://github.com/juliamolsim/atomscalculatorsutilities.jl

Utilities for implementing AtomsCalculators
https://github.com/juliamolsim/atomscalculatorsutilities.jl

Last synced: about 1 month ago
JSON representation

Utilities for implementing AtomsCalculators

• Host: GitHub
• URL: https://github.com/juliamolsim/atomscalculatorsutilities.jl
• Owner: JuliaMolSim
• License: mit
• Created: 2024-03-28T23:04:18.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-20T18:21:41.000Z (4 months ago)
• Last Synced: 2025-02-23T14:16:51.527Z (2 months ago)
• Language: Julia
• Homepage:
• Size: 210 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AtomsCalculatorsUtilities

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliamolsim.github.io/AtomsCalculatorsUtilities.jl/stable/)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliamolsim.github.io/AtomsCalculatorsUtilities.jl/dev/)

[![Build Status](https://github.com/juliamolsim/AtomsCalculatorsUtilities.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/juliamolsim/AtomsCalculatorsUtilities.jl/actions/workflows/CI.yml?query=branch%3Amain)

This package provides a variety of utilities to implement interatomic potentials, including e.g. generic functionality for site potentials and pair potentials, combination calculators, subsystem calculators and so forth. It also provides some simple tools for testing.

At the moment this package only implements the high-level AtomsCalculators 0.2 interface, but not yet the low-level interface, in particular the conventions for parameterized models still needs to be implemented. 

## List of current features

- Pair- and site potential building tools

- Utility calculators

- [i-PI](https://ipi-code.org) interface

- Testing tools for calculators

## i-PI interface

The interface is based on server and calculator, called driver, interaction.

Server is setup by either network mode or unixsocket mode.

Julia server can be started with

```julia

using AtomsCalculatorsUtilities.IPI

# network mode on localhost 

calc = IPIcalculator(ip"127.0.0.1"; port=33415)

# unixsocket mode with socket at /tmp/ipi_mysocket

calc = IPIcalculator("mysocket"; unixsocket=true,  basename="/tmp/ipi_")

```

Julia driver can be started with

```julia

using AtomsCalculatorsUtilities.IPI

sys = # generate system that sets up atom types for the calculator

calc = # generate a AtomsCalculators calculator

# network mode on localhost 

run_driver(ip"127.0.0.1", calc, sys; port=33415)

# unixsocket mode with socket at /tmp/ipi_mysocket

run_driver("mysocket", calc, sys; unixsocket=true,  basename="/tmp/ipi_")

```

Note, that you need to give driver AtomsBase structure that defines atom types.

If you want to change either number or types of atoms, you need to create new driver.

i-PI protocol requires values for energy, forces and virial.

If you don't need virial or if your calculator does not support virial calculation,

you can wrap your calculator to a utility calculator that returns zero virials

```julia

using AtomsCalculatorsUtilities.Calculators

my_zero_vir_calc = ZeroVirialCalculator(mycalc)

```