Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lzehl authored Jan 16, 2025
1 parent f2b3d34 commit e175152
Showing 1 changed file with 61 additions and 11 deletions.
72 changes: 61 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,74 @@
<a href="/img/light_openMINDS-chem-logo.png">
<a href="/img/openMINDS_chemicals_logo_light.png">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="/img/dark_openMINDS-chem-logo.png">
<source media="(prefers-color-scheme: light)" srcset="/img/light_openMINDS-chem-logo.png">
<img alt="openMINDS chemicals logo" src="/img/light_openMINDS-chem-logo.png" title="openMINDS chemicals" align="right" height="70">
<source media="(prefers-color-scheme: dark)" srcset="/img/openMINDS_chemicals_logo_dark.png">
<source media="(prefers-color-scheme: light)" srcset="/img/openMINDS_chemicals_logo_light.png">
<img alt="openMINDS_chemicals metadata model" src="/img/openMINDS_chemicals_logo_light.png" title="Logo created by U. Schlegel, L. Zehl, C. Hagen Blixhavn" align="right" height="70">
</picture>
</a>

# openMINDS_chemicals

[![GitHub][license-shield]][license-url]
[![GitHub contributors][contributors-shield]][contributors-url]

The **openMINDS_chemicals** repository hosts one of the metadata models of the **openMINDS metadata framework**. It defines modular metadata schemas for describing chemical substances and mixtures.

To generally learn more about the openMINDS metadata framework please go to :arrow_right: [**ReadTheDocs**](https://openminds-documentation.readthedocs.io).
For browsing through the metadata schemas you can also directly jump to the :arrow_right: [**openMINDS chemicals specifications**](https://openminds-documentation.readthedocs.io/en/latest/specifications/chemicals.html).
To generally learn more about the openMINDS metadata framework please go to :arrow_right: [**ReadTheDocs**][docu-url].
There you can also explore directly the :arrow_right: [**openMINDS_chemicals schema specifications**][docu-chemicals-url].

## How to cite

For referencing specificly the openMINDS_chemicals metadata model, please use the following RRID Portal record:
:arrow_right: `openMINDS chemicals metadata model (RRID:SCR_026248)`

Please reference in addition openMINDS in general, using our main RRID Portal record:
:arrow_right: `openMINDS metadata framework (RRID:SCR_023173)`

## How to contribute
The openMINDS metadata framework is an open-source project and contributions from the community are highly appreciated. You can contribute by providing feedback and suggestions through the issue tracker as well as by making pull request for fixing issues and introducing new features.

If you want to contribute please follow our :arrow_right: [**contribution guidelines**](https://openminds-documentation.readthedocs.io/en/latest/shared/how_to_contribute.html).
The openMINDS metadata framework is an open-source project and community contributions are highly appreciated. If you want to contribute please follow our :arrow_right: [**contribution guidelines**][contribution-url].

Schema contributions to openMINDS_chemicals should be raised and discussed on the :arrow_right: [**issue tracker**][issuetracker-chemicals]

General usage questions should be raised and discussed in our :arrow_right: [**community forum**][community-forum].
Alternatively you can get in touch with us through our :arrow_right: **[email protected]**.

General contributions should be raised and discussed on the main :arrow_right: [**openMINDS issue tracker**][issuetracker-main].
Instance contributions should be raised and discussed on the :arrow_right: [**openMINDS_instances issue tracker**][issuetracker-instances].

## Funding and acknowledgements

The openMINDS metadata framework development started in the [**Human Brain Project (HBP)**][hbp-website], funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreements [**SGA-1 (No.720270)**][hbp-sga1-doi], [**SGA-2 (No.785907)**][hbp-sga2-doi], and [**SGA-3 (No. 945539)**][hbp-sga3-doi].

The framework is further developed as part of the EBRAINS 2.0 project, funded European Union's Research and Innovation Program Horizon Europe under Grant Agreement [**GA (No.101147319)**][ebrains2-doi].

The framework also receives support from the [**Helmholtz International BigBrain Analytics and Learning Laboratory (HIBALL)**][hiball-url].

## Collaboration partners

The openMINDS metadata framework is closely collaborating with the [**InterLex Project**][interlex-dashboard] of the [**SciCrunch Data and Resource Infrastructure**][scicrunch-website] and the [**KnowledgeSpace**][ks-website] hosted by the [**International Neuroinformatics Coordinating Facility (INCF)**][incf-website].

## License
This work is licensed under the MIT License.

**Logo:** The openMINDS logo was created by U. Schlegel, based on an original sketch by C. Hagen Blixhavn and feedback by L. Zehl.
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[community-forum]: https://neurostars.org/t/about-the-openminds-category/31428
[contribution-url]: https://openminds-documentation.readthedocs.io/en/latest/shared/contribution_guidelines.html
[contributors-url]: https://github.com/openMetadataInitiative/openMINDS_chemicals/graphs/contributors
[contributors-shield]: https://img.shields.io/github/contributors/openMetadataInitiative/openMINDS_chemicals
[docu-url]: https://openminds-documentation.readthedocs.io
[docu-chemicals-url]: https://openminds-documentation.readthedocs.io/en/latest/schema_specifications/chemicals.html
[ebrains2-doi]: https://doi.org/10.3030/101147319
[hiball-url]: https://bigbrainproject.org/hiball.html
[hbp-sga1-doi]: https://doi.org/10.3030/720270
[hbp-sga2-doi]: https://doi.org/10.3030/785907
[hbp-sga3-doi]: https://doi.org/10.3030/945539
[hbp-website]: https://www.humanbrainproject.eu
[incf-website]: https://www.incf.org
[interlex-dashboard]: https://scicrunch.org/scicrunch/interlex/dashboard
[issuetracker-chemicals]: https://github.com/openMetadataInitiative/openMINDS_chemicals/issues
[issuetracker-instances]: https://github.com/openMetadataInitiative/openMINDS_instances/issues
[issuetracker-main]: https://github.com/openMetadataInitiative/openMINDS/issues
[ks-website]: https://knowledge-space.org
[license-url]: https://raw.githubusercontent.com/openMetadataInitiative/openMINDS_chemicals/v1/LICENSE
[license-shield]: https://img.shields.io/github/license/openMetadataInitiative/openMINDS_chemicals
[scicrunch-website]: https://scicrunch.org

0 comments on commit e175152

Please sign in to comment.