Skip to content

Commit f74b9c5

Browse files
committed
chore: README modified with DeepWiki and arXiv badges, CITATION.cff added
1 parent 86a3c5e commit f74b9c5

File tree

3 files changed

+80
-14
lines changed

3 files changed

+80
-14
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
## Unreleased
2+
3+
### Added
4+
5+
- Added DeepWiki integration badge to README.md for community Q&A support:
6+
- [Ask DeepWiki](https://deepwiki.com/slimeslab/ComProScanner)
7+
- Added arXiv preprint badge to README.md:
8+
9+
- [arXiv:2510.20362](https://arxiv.org/abs/2510.20362)
10+
11+
- [CITATION.cff](https://github.com/slimeslab/ComProScanner/blob/main/CITATION.cff) added for standardized citation information based on the latest release and arXiv preprint.
12+
13+
### Changed
14+
15+
- Moved the README badges section from html `p` tags to markdown format for better compatibility across platforms.
16+
117
## [0.1.4] - 02-12-2025
218

319
### Added
@@ -27,6 +43,12 @@
2743

2844
- Arguments related to data cleaning removed from data extraction function.
2945

46+
### Changed
47+
48+
- README images updated with raw GitHub links for better reliability:
49+
- [ComProScanner Logo](https://raw.githubusercontent.com/aritraroy24/ComProScanner/main/assets/comproscanner_logo.png)
50+
- [ComProScanner Workflow](https://raw.githubusercontent.com/aritraroy24/ComProScanner/main/assets/overall_workflow.png)
51+
3052
## [0.1.3] - 04-11-2025
3153

3254
### Fixed

CITATION.cff

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
cff-version: "1.2.0"
2+
authors:
3+
- family-names: Roy
4+
given-names: Aritra
5+
orcid: "https://orcid.org/0000-0003-0243-9124"
6+
- family-names: Grisan
7+
given-names: Enrico
8+
orcid: "https://orcid.org/0000-0002-7365-5652"
9+
- family-names: Buckeridge
10+
given-names: John
11+
orcid: "https://orcid.org/0000-0002-2537-5082"
12+
- family-names: Gattinoni
13+
given-names: Chiara
14+
orcid: "https://orcid.org/0000-0002-3376-6374"
15+
contact:
16+
- family-names: Roy
17+
given-names: Aritra
18+
orcid: "https://orcid.org/0000-0002-4928-2935"
19+
message: If you use this software, please cite our article on arXiv.
20+
preferred-citation:
21+
authors:
22+
- family-names: Roy
23+
given-names: Aritra
24+
orcid: "https://orcid.org/0000-0003-0243-9124"
25+
- family-names: Grisan
26+
given-names: Enrico
27+
orcid: "https://orcid.org/0000-0002-7365-5652"
28+
- family-names: Buckeridge
29+
given-names: John
30+
orcid: "https://orcid.org/0000-0002-2537-5082"
31+
- family-names: Gattinoni
32+
given-names: Chiara
33+
orcid: "https://orcid.org/0000-0002-3376-6374"
34+
date-published: 2025-10-23
35+
identifiers:
36+
- type: other
37+
value: "arXiv:2510.20362"
38+
description: "arXiv preprint"
39+
title: "ComProScanner: A multi-agent based framework for composition-property structured data extraction from scientific literature"
40+
type: article
41+
url: "https://arxiv.org/abs/2510.20362"
42+
repository-code: "https://github.com/slimeslab/ComProScanner"
43+
license: MIT
44+
title: "ComProScanner: A multi-agent based framework for composition-property structured data extraction from scientific literature"
45+
type: software
46+
url: "https://slimeslab.github.io/ComProScanner/"
47+
version: "0.1.4"
48+
date-released: 2025-12-03
49+
keywords:
50+
- materials science
51+
- data extraction
52+
- multi-agent systems
53+
- machine learning
54+
- computational materials science
55+
- text mining
56+
- composition-property database

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
<p align="center">
22
<img src="https://raw.githubusercontent.com/aritraroy24/ComProScanner/refs/heads/main/assets/comproscanner_logo.png" alt="ComProScanner Logo" width="500"/>
3-
<br><br>
4-
<a href="https://www.python.org/downloads/">
5-
<img src="https://img.shields.io/badge/python-3.12%20%7C%203.13-blue.svg?logo=python&logoColor=white" alt="Python Version"/>
6-
</a>&thinsp;<a href="https://opensource.org/licenses/MIT">
7-
<img src="https://custom-icon-badges.demolab.com/badge/license-MIT-yellow.svg?logo=law&logoColor=white" alt="License: MIT"/>
8-
</a>&thinsp;<a href="https://pypi.org/project/comproscanner/">
9-
<img src="https://img.shields.io/pypi/v/comproscanner?logo=pypi&logoColor=white" alt="PyPI"/>
10-
</a>&thinsp;<a href="https://slimeslab.github.io/ComProScanner/">
11-
<img src="https://custom-icon-badges.demolab.com/badge/docs-latest-brightgreen.svg?logo=materialformkdocs&logoColor=white" alt="Documentation"/>
12-
</a>&thinsp;<a href="https://codecov.io/gh/aritraroy24/ComProScanner">
13-
<img src="https://img.shields.io/codecov/c/github/aritraroy24/ComProScanner?logo=codecov&logoColor=white&label=coverage&color=e62277" alt="Coverage"/>
14-
</a>&thinsp;<a href="https://pypi.org/project/comproscanner/">
15-
<img src="https://custom-icon-badges.demolab.com/pypi/dm/comproscanner?logo=download&logoColor=white&color=purple" alt="PyPI Downloads"/>
16-
</a>
173
</p>
184

5+
[![Python Version](https://img.shields.io/badge/python-3.12%20%7C%203.13-blue.svg?logo=python&logoColor=white)](https://www.python.org/downloads/) [![License: MIT](https://custom-icon-badges.demolab.com/badge/license-MIT-yellow.svg?logo=law&logoColor=white)](https://opensource.org/licenses/MIT) [![PyPI](https://img.shields.io/pypi/v/comproscanner?logo=pypi&logoColor=white)](https://pypi.org/project/comproscanner/) [![Documentation](https://custom-icon-badges.demolab.com/badge/docs-latest-brightgreen.svg?logo=materialformkdocs&logoColor=white)](https://slimeslab.github.io/ComProScanner/) [![Coverage](https://img.shields.io/codecov/c/github/aritraroy24/ComProScanner?logo=codecov&logoColor=white&label=coverage&color=e62277)](https://codecov.io/gh/aritraroy24/ComProScanner) [![PyPI - Downloads](https://custom-icon-badges.demolab.com/pypi/dm/comproscanner?logo=download&logoColor=white&color=purple)](https://pypistats.org/packages/comproscanner) [![Ask DeepWiki](https://custom-icon-badges.demolab.com/badge/Ask%20DeepWiki-brightgreen.svg?logo=deepwikidevin&logoColor=white&labelColor=grey&color=5ab998)](https://deepwiki.com/slimeslab/ComProScanner) [![arXiv Preprint](https://custom-icon-badges.demolab.com/badge/arXiv-2510.20362-brightgreen.svg?logo=arxiv&logoColor=white&color=b22929)](https://arxiv.org/abs/2510.20362)
6+
197
# ComProScanner
208

219
**A comprehensive Python package for extracting composition-property data from scientific articles for building databases**

0 commit comments

Comments
 (0)