Skip to content

Commit

Permalink
Merge pull request #228 from Steinbeck-Lab/feat-docs-updates
Browse files Browse the repository at this point in the history
Feat docs updates
  • Loading branch information
CS76 authored Aug 30, 2024
2 parents f7d8eed + fc87ac8 commit 8408fd4
Show file tree
Hide file tree
Showing 198 changed files with 957 additions and 901 deletions.
45 changes: 30 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,61 @@
<p align="center"><a href="https://COCONUT.naturalproducts.net/" target="_blank"><img src="/public/img/logo.png" width="400" alt="COCONUT Logo"></a></p>

<p align="center">
<a href="https://COCONUT.naturalproducts.net/" target="_blank">
<img src="/public/img/logo.png" width="400" alt="COCONUT Logo">
</a>
<h3 align="center">COlleCtion of Open Natural prodUcTs</h3>
</p>

<div align="center">

[![License](https://img.shields.io/badge/License-MIT%202.0-blue.svg)](https://opensource.org/licenses/MIT)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-blue.svg)](https://GitHub.com/Steinbeck-Lab/coconut/graphs/commit-activity)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Steinbeck-Lab/coconut/graphs/commit-activity)
[![GitHub issues](https://img.shields.io/github/issues/Steinbeck-Lab/coconut.svg)](https://GitHub.com/Steinbeck-Lab/coconut/issues/)
[![GitHub contributors](https://img.shields.io/github/contributors/Steinbeck-Lab/coconut.svg)](https://GitHub.com/Steinbeck-Lab/coconut/graphs/contributors/)
[![RDKit badge](https://img.shields.io/badge/Powered%20by-RDKit-3838ff.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQBAMAAADt3eJSAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAFVBMVEXc3NwUFP8UPP9kZP+MjP+0tP////9ZXZotAAAAAXRSTlMAQObYZgAAAAFiS0dEBmFmuH0AAAAHdElNRQfmAwsPGi+MyC9RAAAAQElEQVQI12NgQABGQUEBMENISUkRLKBsbGwEEhIyBgJFsICLC0iIUdnExcUZwnANQWfApKCK4doRBsKtQFgKAQC5Ww1JEHSEkAAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMi0wMy0xMVQxNToyNjo0NyswMDowMDzr2J4AAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjItMDMtMTFUMTU6MjY6NDcrMDA6MDBNtmAiAAAAAElFTkSuQmCC)](https://www.rdkit.org/)
![Workflow](https://GitHub.com/Steinbeck-Lab/coconut/actions/workflows/dev-build.yml/badge.svg)
[![Powered by Laravel](https://img.shields.io/badge/Powered%20by-Laravel-red.svg?style=flat&logo=Laravel)](https://laravel.com)
[![DOI](https://zenodo.org/badge/778260166.svg)](https://zenodo.org/doi/10.5281/zenodo.13283948)

<!---
![Workflow](https://GitHub.com/Steinbeck-Lab/coconut/actions/workflows/prod-build.yml/badge.svg)
[![DOI](https://zenodo.org/badge/DOI/10.??/zenodo.??.svg)](https://doi.org/10.??/zenodo.??)
-->
</div>

## About COCONUT
## ![About](https://www.google.com/s2/favicons?domain=naturalproducts.net) About COCONUT

COCONUT is an open-access database dedicated to collecting and disseminating natural products. It aims to provide researchers, scientists, and enthusiasts with comprehensive and easily accessible data on a wide variety of natural compounds. The database includes detailed information on the chemical structures, literature references and sources of these compounds, facilitating research and discovery in natural products.

## Features
## ![Features](https://www.google.com/s2/favicons?domain=github.com) Features

- **Extensive Database**: Contains information on thousands of natural products from diverse sources (63).
- **Chemical Structures**: Provides detailed chemical structures for each natural product, aiding research and identification.
- **Search and Filter**: Advanced search and filtering options to find compounds based on specific criteria easily.
- **Online Submission and Curation**: Allows users to contribute new data, ensuring the database remains current and comprehensive.
- **API Access**: Provides API access for seamless integration with other tools and databases.

## ![Calculations](https://www.google.com/s2/favicons?domain=python.org) Descriptor calculations

COCONUT data curation and descriptors calculation are performed using our [microservices](https://github.com/Steinbeck-Lab/cheminformatics-python-microservice). More details can be found in our [API documentation](https://api.naturalproducts.net/docs).

## Descriptor calculations
COCONUT data curation and descriptors calculation are performed using our [microservices](https://github.com/Steinbeck-Lab/cheminformatics-python-microservice). More details can be found [here](https://api.naturalproducts.net/docs).
## ![License](https://www.google.com/s2/favicons?domain=opensource.org) License

## License
COCONUT infrastructure code is licensed under the MIT license - see the [LICENSE](https://GitHub.com/Steinbeck-Lab/coconut/blob/documentation/LICENSE). Every source on COCONUT comes with its own specific license. It is essential to review the license details for each dataset before using it.

## COCONUT (Legacy) - Citation
## ![Citation](https://www.google.com/s2/favicons?domain=doi.org) COCONUT (Legacy) - Citation

Sorokina, M., Merseburger, P., Rajan, K. et al. COCONUT online: COlleCtion of Open Natural prodUcTs database. J Cheminform 13, 2 (2021). https://doi.org/10.1186/s13321-020-00478-9

## Maintained by
## ![Maintained](https://www.google.com/s2/favicons?domain=uni-jena.de) Maintained by

The COCONUT database and its infrastructure are developed and maintained by the [Steinbeck group](https://cheminf.uni-jena.de) at the [Friedrich Schiller University](https://www.uni-jena.de/en/) Jena, Germany.

The code for this web application is released under the [MIT license](https://opensource.org/licenses/MIT). Copyright © CC-BY-SA 2024
<p align="center"><a href="https://cheminf.uni-jena.de/" target="_blank"><img src="https://github.com/Kohulan/DECIMER-Image-to-SMILES/blob/master/assets/CheminfGit.png" width="800" alt="cheminf Logo"></a></p>

## Acknowledgments :bulb:
<p align="center">
<a href="https://cheminf.uni-jena.de/" target="_blank">
<img src="https://github.com/Kohulan/DECIMER-Image-to-SMILES/blob/master/assets/CheminfGit.png" width="400" alt="cheminf Logo">
</a>
</p>

## ![Acknowledgments](https://www.google.com/s2/favicons?domain=dfg.de) Acknowledgments

Funded by the [Deutsche Forschungsgemeinschaft (DFG, German Research Foundation)](https://www.dfg.de/) under the [ChemBioSys](https://www.chembiosys.de/en/) (Project INF) - Project number: **239748522 - SFB 1127**.

Expand All @@ -52,3 +65,5 @@ Funded by the [Deutsche Forschungsgemeinschaft (DFG, German Research Foundation)
</a>
<a href="https://www.chembiosys.de/en/welcome.html" target="_blank">
<img src="https://github.com/Steinbeck-Lab/cheminformatics-microservice/assets/30716951/45c8e153-8322-4563-a51d-cbdbe4e08627" width="40%" alt="Chembiosys Logo">
</a>
</div>
52 changes: 26 additions & 26 deletions docs/.vitepress/cache/deps/@theme_index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 9 additions & 9 deletions docs/.vitepress/cache/deps/_metadata.json
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
{
"hash": "beae1d4b",
"configHash": "c72d62c6",
"hash": "ac4c7283",
"configHash": "d8d0d63c",
"lockfileHash": "cef65b35",
"browserHash": "9e42a1d1",
"browserHash": "7301b1ca",
"optimized": {
"vue": {
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "83726183",
"fileHash": "dba9177d",
"needsInterop": false
},
"vitepress > @vue/devtools-api": {
"src": "../../../../node_modules/@vue/devtools-api/dist/index.js",
"file": "vitepress___@vue_devtools-api.js",
"fileHash": "31cb44a6",
"fileHash": "497f197f",
"needsInterop": false
},
"vitepress > @vueuse/core": {
"src": "../../../../node_modules/@vueuse/core/index.mjs",
"file": "vitepress___@vueuse_core.js",
"fileHash": "8b62e4bc",
"fileHash": "10be8d6f",
"needsInterop": false
},
"@theme/index": {
"src": "../../../../node_modules/vitepress/dist/client/theme-default/index.js",
"file": "@theme_index.js",
"fileHash": "42cfaa9c",
"fileHash": "c306ae23",
"needsInterop": false
}
},
"chunks": {
"chunk-4FWP2Y5K": {
"file": "chunk-4FWP2Y5K.js"
"chunk-7LUTEMNG": {
"file": "chunk-7LUTEMNG.js"
},
"chunk-PAUCAATC": {
"file": "chunk-PAUCAATC.js"
Expand Down
7 changes: 0 additions & 7 deletions docs/.vitepress/cache/deps/chunk-4FWP2Y5K.js.map

This file was deleted.

Loading

0 comments on commit 8408fd4

Please sign in to comment.