Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document external calculators? #380

Open
ElliottKasoar opened this issue Jan 13, 2025 · 1 comment
Open

Document external calculators? #380

ElliottKasoar opened this issue Jan 13, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation question Further information is requested

Comments

@ElliottKasoar
Copy link
Member

I'm not proposing we actively work towards more support from other calculators, but it may be useful to note that most janus calculations (should) already work with any ASE-compatible calculator. For example:

from janus_core.calculations.single_point import SinglePoint
from ase.calculators.lj import LennardJones
from ase.io import read

struct = read("tests/data/NaCl.cif")
struct.calc = LennardJones()

single_point = SinglePoint(
    struct=struct,
)

print(single_point.run())

returns

{'energy': -0.05900093815771919, 'forces': array([[0., 0., 0.],
       [0., 0., 0.],
       [0., 0., 0.],
       [0., 0., 0.],
       [0., 0., 0.],
       [0., 0., 0.],
       [0., 0., 0.],
       [0., 0., 0.]]), 'stress': array([0.00211953, 0.00211953, 0.00211953, 0.        , 0.        ,
       0.        ])}

This might help make a comparison with DFT/classical force fields, or enable the use of a currently unsupported MLIP, so perhaps work documenting?

@ElliottKasoar ElliottKasoar added documentation Improvements or additions to documentation question Further information is requested labels Jan 13, 2025
@alinelena
Copy link
Member

good point, add a section in documentation about it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants