Giter Club home page Giter Club logo

mapper's Introduction

Mapper

Mapper is an implementation of approximate structure-matching algorithm proposed by Lynch and Willett [1]. It applies the Morgan algorithm [2] with different stopping rule simultaneously to both reacting molecules to detect inter-molecular equivalences.

The authors of Ref. [1] are a bit vague as far as assigning initial extended connectivity indices is concerned. Thus, besides original Morgan's approach, two alternative methods [3,4] were implemented.

Requirements

Mapper depends on:

Installation

Create a virtual environment with

python3 -m venv <ENV_DIR>

where <ENV_DIR> is any directory, for example $HOME/venvs/mapper.

Clone the package repository with

git clone https://github.com/mxk62/Mapper.git

Switch to the package directory and activate the virtual environment you created earlier

cd Mapper
source $HOME/venvs/mapper

and install the package using pip

pip install --user .

If you want to be able to generate package documentation, you need to install additional (optional) dependencies with

pip install --user .[docs]

instead. Then you can generate the documentation simply with

cd docs
make html

If building documentation finished successfully, open _build/html/index.html in your web browser.

Note

A fair warning though. At the moment the documentation is just an API reference. Having said that this should provide some insight how to use the package.

Misc

Other files you can find in the package directory are:

  • demo.py: a (very) simple CLI for demonstration purposes.
  • rxns.smi: example reactions from Ref. [1] encoded in SMILES format.

References

  1. MF Lynch and P Willett, The Automatic Detection of Chemical Reaction Sites, J Chem Inf Comput Sci 18, 154-159 (1978)
  2. HL Morgan, , The generation of a Unique Machine Description for Chemical Structures---A Technique Developed at Chemical Abstract Service, J Chem Doc 5, 107-113 (1965)
  3. CA Shelley and ME Munk, Computer Perception of Topological Symmetry, J Chem Inf Mod 17, 110-113 (1977)
  4. K Funatsu, T Endo, N Kotera, and SI Sasaki, Automatic Recognition of Reaction Site in Organic Chemnical Reactions, Tetrahedron Computer Methodology 1, 53-69 (1988)

mapper's People

Contributors

mxk62 avatar

Stargazers

Haifan avatar pkuljx avatar  avatar  avatar Xiaodong Wang avatar WeizhongTu avatar

Watchers

Kyle Bishop avatar Syeda Sabrina avatar shashank pandey avatar

mapper's Issues

Add Sphinx "scaffolding"

The package has no documentation at the moment, but doctrings should be good enough to provide a starting point. To make the navigation among them easier add Sphinx scaffolding so an HTML document showing the docstrings could be generated with minimal effort.

Port the code to Python 3

This code was written when Python 2.7 was still a "gold standard". However, Python 2 is now dead. It's time to port the code to Python 3.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.