.. MAICA documentation master file, created by
   sphinx-quickstart on Thu Aug  5 17:28:05 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Multidisciplinary Artificial Intelligence with Chemical Abstraction (MAICA)
===========================================================================

This is a python package for machine learning with chemical data.
It provides various pre-processing modules for chemical data, such as engineering conditions, chemical formulas, and molecular structures.
Also, several wrapper classes and functions are included for chemical machine learning.
This package was implemented based on `Scikit-learn <https://scikit-learn.org/stable/>`_ and `PyTorch <https://pytorch.org/>`_.


Installation
------------

Before installing MAICA, several required packages should be installed in your environment.
We highly recommend to use `Anaconda <https://www.anaconda.com/>`_ to build your Python environment for MAICA.

1. Install a cheminformatics package `RDKit <https://www.rdkit.org/>`_.
   RDKit is available at Anaconda archive.
   You can install RDKit using the following command in the Anaconda prompt.

>>> conda install -c rdkit rdkit

2. Install a deep learning framework `PyTorch <https://pytorch.org/>`_.
   **If you want to build your machine learning models using GPU,** `CUDA <https://developer.nvidia.com/cuda-toolkit>`_ **>= 11.1 must be installed your machine.**
   With CUDA of version 11.1, you can install PyTorch using the following command.

>>> conda install pytorch torchvision torchaudio cudatoolkit=11.1 -c pytorch -c conda-forge

3. Install a graph-based deep learning framework `PyTorch Geometric <https://pytorch-geometric.readthedocs.io/en/latest/>`_.
   It must be installed to build machine learning models that predict target values from molecular and crystal structures.
   You can install PyTorch Geometric using the following command.

>>> conda install pytorch-geometric -c rusty1s -c conda-forge

4. Install required packages from ``requirements.txt`` in GitHub.
   After downloading the requirements file, you can install all required packages using the following commend.

>>> conda install --file requirements.txt

5. (*Optional*) If your operating system is Windows, install `Graphviz <https://graphviz.org/>`_ to visualize interpretable information of machine learning algorithms.
   You can install Graphviz using the following command.

>>> conda install -c conda-forge python-graphviz

6. Finally, install MAICA in your Python environment with the following command.

>>> pip install maica


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`