semvec/pypi-packages huggingface dataset:
aamutils 0.0.10
Collection of atom-atom-mapping utility functions.
Requires Python: >=3.11

# Atom-atom-mapping Utils

A collection of atom-atom-mapping utility functions. 

## Installation

The easiest way to use AAMUtils is by installing the PyPI package
[aamutils](https://pypi.org/project/aamutils/).

```
pip install aamutils
```

## Usage

### Use in command line

The input is a list of partial atom-atom-maps (AAMs). Data is read line-by-line
from a text file. Each line should contain one reaction SMILES.

Here is a simple example extending the partial AAM to a complete AAM. First
generate the input data:

```bash
echo "CCC[Cl:1].[N:2]>>CCC[N:2].[Cl:1]" > testinput.txt
```

Next, run AAMUtils to expand the partial AAM. 

```bash 
python3 -m aamutils expand testinput.txt
```

The output is written to 'testinput_extended.json'. 

```bash 
cat testinput_extended.json 
```

```json 
[
    {
        "input": "CCC[Cl:1].[N:2]>>CCC[N:2].[Cl:1]",
        "expanded_aam": "[Cl:1][CH2:5][CH2:4][CH3:3].[NH3:2]>>[ClH:1].[NH2:2][CH2:3][CH2:4][CH3:5]",
        "ilp_status": "Optimal",
        "optimization_result": 4.0,
        "invalid_reaction_center": false,
        "reaction_edges": 4
    }
]
```
### Use in script
  ```python
    from aamutils.aam_expand import extend_aam_from_rsmi

    rsmi = "CC[CH2:3][Cl:1].[N:2]>>CC[CH2:3][N:2].[Cl:1]"

    result_smiles = extend_aam_from_rsmi(rsmi)

    print(result_smiles)
    >>> "[Cl:1][CH2:3][CH2:5][CH3:4].[NH3:2]>>[ClH:1].[NH2:2][CH2:3][CH2:5][CH3:4]"
```

## Benchmark

To rerun the benchmarks from the paper use the ``benchmark.py`` script. The
reported results can be reproduced by running the following commands:

### (1) Extend partial reaction center (50%, 75% and 100% missing atoms)  

```
python3 benchmark.py --remove-mode rc --remove-ratio 0.5 --seed 42
```
```
python3 benchmark.py --remove-mode rc --remove-ratio 0.75 --seed 42
```
```
python3 benchmark.py --remove-mode rc --remove-ratio 1 --seed 42
```

### (2) Extend partial AAM with fully mapped RC 
```
python3 benchmark.py --remove-mode keep_rc --remove-ratio 1 --seed 42
```


## Functionality
Here is an overview of implemented functionality:

- SMILES to graph and graph to SMILES parsing
- Reaction center validity checks
- ITS graph generation
- Expand partial AAM to complete AAM on balanced reactions
- AAMing based on minimal chemical distance (MCD) for balanced reactions

## License

This project is licensed under MIT License - see the [License](LICENSE) file
for details.

## Acknowledgments

This project has received funding from the European Unions Horizon Europe
Doctoral Network programme under the Marie-Skłodowska-Curie grant agreement No
101072930 (TACsy -- Training Alliance for Computational)