Skip to content

Commit

Permalink
Merge branch 'main' into fane
Browse files Browse the repository at this point in the history
  • Loading branch information
faneshala authored May 26, 2024
2 parents f038b7d + f6f95f4 commit 3f30c06
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,75 +13,77 @@ The Chemical Equation Equilibrator is a Python program that balances and equilib

- NumPy: Required for handling arrays and matrices.


```
pip install numpy

```

- RDKit: A cheminformatics toolkit used for parsing SMILES strings and generating 2D molecular structures.


```
pip install -c conda-forge rdkit

```

- PuLP: A linear programming library used for solving integer linear programming problems.


```
pip install pulp
```

- PIL: Python Imaging Library used for image manipulation.


```
pip install pillow

```

- rxnmapper: A package for mapping reactions.


```
pip install rxnmapper
```

- IPython:Interactive computing in Python.


```
pip install ipython

```

- request:HTTP library for making requests.


```
pip install request

```

- Rxn-INSIGHT relies on NumPy, Pandas, RDKit, RDChiral, and RXNMapper.

A virtual environment can be installed with Anaconda as follows:

```
console
conda create -n rxn-insight python=3.10
conda activate rxn-insight
```



```
git clone https://github.com/schwallergroup/Rxn-INSIGHT.git
cd Rxn-INSIGHT
pip install .

```

Or, for developing with the optional dependencies, which are required to run the tests
and build the docs:
```
pip install -e ".[test,doc]"

```

All of the test environments can be run using the command tox from the top directory.
Alternatively, individual test environments can be run using the -e flag as
in tox -e env-name. To run the tests, tests with coverage report, style checks, and
docs build, respectively:

```
tox -e py3
tox -e py3-coverage
tox -e style
tox -e docs

```

## Usage

Expand All @@ -98,7 +100,7 @@ tox -e docs
`M. R. Dobbelaere, I. Lengyel, C. V. Stevens, and K. M. Van Geem,
‘Rxn-INSIGHT: fast chemical reaction analysis using bond-electron matrices’, J. Cheminform., vol. 16, no. 1, Mar. 2024.`


```
@ARTICLE{Dobbelaere2024-es,
title = "{Rxn-INSIGHT}: fast chemical reaction analysis using
bond-electron matrices",
Expand All @@ -113,4 +115,4 @@ tox -e docs
copyright = "https://creativecommons.org/licenses/by/4.0",
language  = "en"
}

```
1 change: 1 addition & 0 deletions tests/test_example_module.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

from src/chembalancer.chembalancer import hello_smiles


Expand Down
1 change: 1 addition & 0 deletions tests/test_get_smiles_from_name.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

from src/chembalancer.chembalancer import get_smiles_from_name


def test_get_smiles_from_name_success():
mock_response = {
"PropertyTable": {
Expand Down

0 comments on commit 3f30c06

Please sign in to comment.