Skip to content

nguyenka/mlatom

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

104 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MLatom-banner

Downloads Downloads Downloads

Updates

MLatom

MLatom is a package for atomistic simulations with machine learning. See official website MLatom.com for more information, manuals and tutorials.

It is an open-source software under the MIT license (modified to request proper citations). MLatom is a part of XACS (Xiamen Atomistic Computing Suite) since 2022 and you can use MLatom @ XACS cloud computing service for using the package online via web browser.

The MLatom can be also conveniently installed via pip:

python3 -m pip install -U MLatom

Dependences may need to be also installed as described on the official website.

Installation from Source

To install the package from source (e.g., for development), you will need a Fortran compiler (like gfortran) installed and available in your system's PATH.

The installation is then handled by pip. From the root directory of this project, run:

# For a standard installation
python3 -m pip install .

# Or for an editable (development) installation
python3 -m pip install -e .

This process will automatically compile the necessary Fortran components and install the mlatom package.

Contributions and derivatives

We highly welcome the contributions to the MLatom project. You may also create your own private derivatives of the project by following the license requirements.

If you want to contribute to the main MLatom repository, the easiest way is to create a fork and then send a pull request. Alternatively, you can ask us to create a branch for you. After we receive a pull request, we will review the submitted modifications to the code and may clean up of the code and do other changes to it and eventually include your modifications in the main repository and the official release.

About

AI-enhanced computational chemistry

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 79.1%
  • Fortran 19.8%
  • Julia 0.9%
  • Makefile 0.1%
  • C++ 0.1%
  • Shell 0.0%