mirror of
https://github.com/rdkit/rdkit.git
synced 2026-06-03 21:44:30 +08:00
massive simplification of README.md (#7831)
* massive simplification of README.md also remove the README * update README in the CMakeLists.txt who knew that the README was referenced in the build system? * grrr * add back the UGM links * review suggestion * review suggestions
This commit is contained in:
@@ -552,7 +552,7 @@ if(NOT RDK_INSTALL_INTREE)
|
||||
|
||||
|
||||
endif(RDK_BUILD_PYTHON_WRAPPERS)
|
||||
install(FILES README license.txt
|
||||
install(FILES README.md license.txt
|
||||
DESTINATION ${RDKit_ShareDir}
|
||||
COMPONENT base
|
||||
)
|
||||
@@ -641,7 +641,7 @@ endif()
|
||||
SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "RDKit")
|
||||
SET(CPACK_PACKAGE_VENDOR "rdkit.org")
|
||||
SET(CPACK_PACKAGE_CONTACT "greg.landrum@gmail.com")
|
||||
SET(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README")
|
||||
SET(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
|
||||
SET(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/license.txt")
|
||||
SET(CPACK_PACKAGE_VERSION_MAJOR ${RDKit_Year})
|
||||
SET(CPACK_PACKAGE_VERSION_MINOR ${RDKit_Month})
|
||||
|
||||
18
README
18
README
@@ -1,18 +0,0 @@
|
||||
Instructions for building the RDKit can be found in the file
|
||||
Docs/Book/Install.md.
|
||||
|
||||
The online version of the documentation is available here:
|
||||
http://www.rdkit.org/docs/index.html
|
||||
|
||||
Some information about using the software from Python is in the
|
||||
"Getting Started in Python" document in Docs/Book
|
||||
|
||||
If you have questions or suggestions, please subscribe to the
|
||||
rdkit-discuss mailing list:
|
||||
http://lists.sourceforge.net/mailman/listinfo/rdkit-discuss
|
||||
|
||||
Please see the file LICENSE for details about the "New BSD"
|
||||
license which covers this software and its associated data and
|
||||
documents.
|
||||
|
||||
# Copyright (C) 2008-2015 Greg Landrum
|
||||
106
README.md
106
README.md
@@ -3,105 +3,65 @@
|
||||
[](https://zenodo.org/badge/latestdoi/10009991)
|
||||
|
||||
|
||||
[RDKit](https://github.com/rdkit/rdkit) is a collection of cheminformatics and machine-learning software written in C++ and Python.
|
||||
## What is it?
|
||||
|
||||
The [RDKit](https://www.rdkit.org) is a collection of cheminformatics and machine-learning software written in C++ and Python.
|
||||
|
||||
* [BSD license](https://github.com/rdkit/rdkit/blob/master/license.txt) - a business friendly license for open source
|
||||
* Core data structures and algorithms in C++
|
||||
* [Python 3.x wrapper](https://www.rdkit.org/docs/GettingStartedInPython.html) generated using Boost.Python
|
||||
* Java and C# wrappers generated with SWIG
|
||||
* JavaScript (generated with emscripten) and CFFI wrappers around important functionality
|
||||
* 2D and 3D molecular operations
|
||||
* [Descriptor](https://www.rdkit.org/docs/GettingStartedInPython.html#list-of-available-descriptors) and [Fingerprint](http://www.rdkit.org/docs/GettingStartedInPython.html#list-of-available-fingerprints) generation for machine learning
|
||||
* Molecular database [cartridge](https://www.rdkit.org/docs/Cartridge.html) for PostgreSQL supporting substructure and similarity searches as well as many descriptor calculators
|
||||
* Cheminformatics nodes for [KNIME](https://www.knime.com/rdkit)
|
||||
* [Contrib](https://github.com/rdkit/rdkit/tree/master/Contrib) folder with useful community-contributed software harnessing the power of the RDKit
|
||||
|
||||
#### Community
|
||||
|
||||
* [Mailing list](https://sourceforge.net/p/rdkit/mailman/)
|
||||
* [GitHub discussions](https://github.com/rdkit/rdkit/discussions)
|
||||
* [LinkedIn](https://www.linkedin.com/groups/RDKit-8192558/about)
|
||||
## Installation and getting started
|
||||
|
||||
#### Code
|
||||
If you are working in Python and using conda (our recommendation), installation is super easy:
|
||||
|
||||
* [GitHub code](https://github.com/rdkit) and [bug tracker](https://github.com/rdkit/rdkit/issues)
|
||||
```shell-session
|
||||
$ conda install -c conda-forge rdkit
|
||||
```
|
||||
|
||||
## Web presence
|
||||
You can then take a look at our [Getting Started in Python](https://rdkit.org/docs/GettingStartedInPython.html) guide.
|
||||
|
||||
* [RDKit web page](https://rdkit.org)
|
||||
* [Blog](https://greglandrum.github.io/rdkit-blog/)
|
||||
* [Documentation](https://www.rdkit.org/docs/index.html)
|
||||
|
||||
#### Materials from user group meetings
|
||||
|
||||
* [2012 UGM](http://www.rdkit.org/UGM/2012/)
|
||||
* [2013 UGM](https://github.com/rdkit/UGM_2013)
|
||||
* [2014 UGM](https://github.com/rdkit/UGM_2014)
|
||||
* [2015 UGM](https://github.com/rdkit/UGM_2015)
|
||||
* [2016 UGM](https://github.com/rdkit/UGM_2016)
|
||||
* [2017 UGM](https://github.com/rdkit/UGM_2017)
|
||||
* [2018 UGM](https://github.com/rdkit/UGM_2018)
|
||||
* [2019 UGM](https://github.com/rdkit/UGM_2019)
|
||||
* [2020 UGM](https://github.com/rdkit/UGM_2020)
|
||||
* [2021 UGM](https://github.com/rdkit/UGM_2021)
|
||||
* [2022 UGM](https://github.com/rdkit/UGM_2022)
|
||||
* [2023 UGM](https://github.com/rdkit/UGM_2023)
|
||||
More detailed installation instructions are available in [Docs/Book/Install.md](https://github.com/rdkit/rdkit/blob/master/Docs/Book/Install.md).
|
||||
|
||||
## Documentation
|
||||
Available on the [RDKit page](https://www.rdkit.org/docs/index.html)
|
||||
and in the [Docs](https://github.com/rdkit/rdkit/tree/master/Docs) folder on GitHub
|
||||
|
||||
## Installation
|
||||
The [RDKit blog](https://greglandrum.github.io/rdkit-blog/) often has useful tips and tricks.
|
||||
|
||||
Installation instructions are available in [Docs/Book/Install.md](https://github.com/rdkit/rdkit/blob/master/Docs/Book/Install.md).
|
||||
## Support and Community
|
||||
|
||||
#### Binary distributions, anaconda, homebrew
|
||||
If you have questions, comments, or suggestions, the best places for those are:
|
||||
|
||||
* [binaries for conda python](https://anaconda.org/rdkit/rdkit) or, if you are using the conda-forge stack, the RDKit is also [available from conda-forge](https://anaconda.org/conda-forge/rdkit).
|
||||
* [RPMs](https://src.fedoraproject.org/rpms/rdkit) for RedHat Enterprise Linux, Centos, and Fedora. Contributed by Gianluca Sforna.
|
||||
* [debs](https://blends.debian.org/debichem/tasks/cheminformatics) for Ubuntu and other Debian-derived Linux distros. Contributed by the Debichem team.
|
||||
* [homebrew](https://github.com/rdkit/homebrew-rdkit) formula for building on the Mac. Contributed by Eddie Cao.
|
||||
* [recipes](https://github.com/rdkit/conda-rdkit) for building using the excellent conda package manager. Contributed by Riccardo Vianello.
|
||||
* [APKs](https://github.com/daverona/alpine-rdkit) for Alpine Linux. Contributed by da Verona
|
||||
* [Wheels](https://pypi.org/project/rdkit/) at PyPi for all major platforms and python versions. Contributed by Christopher Kuenneth
|
||||
* [GitHub discussions](https://github.com/rdkit/rdkit/discussions)
|
||||
* The [mailing list](https://sourceforge.net/p/rdkit/mailman/)
|
||||
|
||||
## Projects using RDKit
|
||||
If you've found a bug or would like to request a feature, please [create an issue](https://github.com/rdkit/rdkit/issues)
|
||||
|
||||
- [ROBERT](https://github.com/jvalegre/robert) - Automated Machine Learning Protocols
|
||||
- [AQME](https://github.com/jvalegre/aqme) - Automated Quantum Mechanical Environment
|
||||
- [chemprop](https://github.com/chemprop/chemprop) - message passing neural networks for molecular property prediction
|
||||
- [RMG](https://github.com/ReactionMechanismGenerator/RMG-Py) - Reaction Mechanism Generator
|
||||
- [RDMC](https://github.com/xiaoruiDong/RDMC) - Reaction Data and Molecular Conformers - package for dealing with reactions, molecules, conformers, mainly in 3D
|
||||
- [pychemprojections](https://github.com/vandan-revanur/pychemprojections) - python library for visualizing various 2D projections of molecules.
|
||||
- [pychemovality](https://github.com/vandan-revanur/pychemovality) - python library for estimating the ovality of molecules.
|
||||
- [ChEMBL Structure Pipeline](https://github.com/chembl/ChEMBL_Structure_Pipeline) - ChEMBL protocols used to standardise and salt strip molecules.
|
||||
- [FPSim2](https://github.com/chembl/FPSim2) - Simple package for fast molecular similarity searches.
|
||||
- [Datamol](https://datamol.io/) ([docs](https://doc.datamol.io/stable/), [repo](https://github.com/datamol-org/datamol/)) - A Python library to intuitively manipulate molecules.
|
||||
- [Scopy](https://github.com/kotori-y/Scopy) ([docs](https://scopy.iamkotori.com/), [paper](https://doi.org/10.1093/bib/bbaa194)) - an integrated negative design Python library for desirable HTS/VS database design
|
||||
- [stk](https://github.com/lukasturcani/stk) ([docs](https://stk.readthedocs.io), [paper](https://onlinelibrary.wiley.com/doi/10.1002/jcc.25377)) -
|
||||
a Python library for building, manipulating, analyzing and automatic design of molecules.
|
||||
- [gpusimilarity](https://github.com/schrodinger/gpusimilarity) - A Cuda/Thrust implementation of fingerprint similarity searching
|
||||
- [Samson Connect](https://www.samson-connect.net) - Software for adaptive modeling and simulation of nanosystems
|
||||
- [mol_frame](https://github.com/apahl/mol_frame) - Chemical Structure Handling for Dask and Pandas DataFrames
|
||||
- [RDKit.js](https://github.com/rdkit/rdkit-js) - The official JavaScript release of RDKit
|
||||
- [DeepChem](https://deepchem.io) - python library for deep learning for chemistry
|
||||
- [mmpdb](https://github.com/rdkit/mmpdb) - Matched molecular pair database generation and analysis
|
||||
- [CheTo](https://github.com/rdkit/CheTo) ([paper](http://pubs.acs.org/doi/10.1021/acs.jcim.7b00249))- Chemical topic modeling
|
||||
- [OCEAN](https://github.com/rdkit/OCEAN) ([paper](http://pubs.acs.org/doi/abs/10.1021/acs.jcim.6b00067))- Optimized cross reactivity estimation
|
||||
- [ChEMBL Beaker](https://github.com/mnowotka/chembl_beaker) - standalone web server wrapper for RDKit and OSRA
|
||||
- [ZINC](http://zinc15.docking.org) - Free database of commercially-available compounds for virtual screening
|
||||
- [sdf_viewer.py](https://github.com/apahl/sdf_viewer) - an interactive SDF viewer
|
||||
- [sdf2ppt](https://github.com/dkuhn/sdf2ppt) - Reads an SDFile and displays molecules as image grid in powerpoint/openoffice presentation.
|
||||
- [MolGears](https://github.com/admed/molgears) - A cheminformatics tool for bioactive molecules
|
||||
- [PYPL](http://www.biochemfusion.com/downloads/#OracleUtilities) - Simple cartridge that lets you call Python scripts from Oracle PL/SQL.
|
||||
- [shape-it-rdkit](https://github.com/jandom/shape-it-rdkit) - Gaussian molecular overlap code shape-it (from silicos it) ported to RDKit backend
|
||||
- [WONKA](http://wonka.sgc.ox.ac.uk/WONKA/) - Tool for analysis and interrogation of protein-ligand crystal structures
|
||||
- [OOMMPPAA](http://oommppaa.sgc.ox.ac.uk/OOMMPPAA/) - Tool for directed synthesis and data analysis based on protein-ligand crystal structures
|
||||
- [OCEAN](https://github.com/rdkit/OCEAN) - web-tool for target-prediction of chemical structures which uses ChEMBL as datasource
|
||||
- [chemfp](http://chemfp.com) - very fast fingerprint searching
|
||||
- [rdkit_ipynb_tools](https://github.com/apahl/rdkit_ipynb_tools) - RDKit Tools for the IPython Notebook
|
||||
- [Vernalis KNIME nodes](https://www.knime.com/book/vernalis-nodes-for-knime-trusted-extension)
|
||||
- [Erlwood KNIME nodes](https://www.knime.com/community/erlwood)
|
||||
- [AZOrange](https://github.com/AZcompTox/AZOrange)
|
||||
We also have a [LinkedIn group](https://www.linkedin.com/groups/RDKit-8192558/about)
|
||||
|
||||
We have a yearly user group meeting (the UGM) where members of the community do presentations and lightning talks on things they've done with the RDKit. Materials from past UGMs, which can quite useful, are also online:
|
||||
* [2012 UGM, London](http://www.rdkit.org/UGM/2012/)
|
||||
* [2013 UGM, Hinxton](https://github.com/rdkit/UGM_2013)
|
||||
* [2014 UGM, Darmstadt](https://github.com/rdkit/UGM_2014)
|
||||
* [2015 UGM, Zurich](https://github.com/rdkit/UGM_2015)
|
||||
* [2016 UGM, Basel](https://github.com/rdkit/UGM_2016)
|
||||
* [2017 UGM, Berlin](https://github.com/rdkit/UGM_2017)
|
||||
* [2018 UGM, Cambridge](https://github.com/rdkit/UGM_2018)
|
||||
* [2019 UGM, Hamburg](https://github.com/rdkit/UGM_2019)
|
||||
* [2020 UGM, virtual](https://github.com/rdkit/UGM_2020)
|
||||
* [2021 UGM, virtual](https://github.com/rdkit/UGM_2021)
|
||||
* [2022 UGM, Berlin](https://github.com/rdkit/UGM_2022)
|
||||
* [2023 UGM, Mainz](https://github.com/rdkit/UGM_2023)
|
||||
* [2024 UGM, Zurich](https://github.com/rdkit/UGM_2024)
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user