Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix grammar per JOSS feedback, fix code example margin, remove reviews #68

Merged
merged 11 commits into from
Nov 10, 2024
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ assignees: ""
- [ ] Locally rendered documentation contains all appropriate pages, including
API references (check no modules are missing), tutorials, and other human
written text is up-to-date with any changes in the code.
- [ ] Installation instructions in the README, documentation and on the website are updated and tested
- [ ] Installation instructions in the README, documentation and on the website
are updated and tested
- [ ] Successfully run any tutorial examples or do functional testing in some
other way.
- [ ] Grammar and writing quality have been checked (no typos).
3 changes: 2 additions & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# API reference

This section contains the automatic API reference for `Cif` and `CifEnsemble` modules in the `cifkit` package.
This section contains the automatic API reference for `Cif` and `CifEnsemble`
modules in the `cifkit` package.

::: cifkit
13 changes: 8 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
## Statement of need

`cifkit` uses .cif files by offering higher-level functions and variables that
enable users to perform complex tasks efficiently with a few lines of code. `cifkit` distinguishes itself from existing libraries by offering higher-level
functions and variables that allow solid-state synthesists to obtain intuitive and
measurable properties impactful properties. It facilitates the visualization of
coordination geometry from each site using four coordination determination
enable users to perform complex tasks efficiently with a few lines of code.
`cifkit` distinguishes itself from existing libraries by offering higher-level
functions and variables that allow solid-state synthesists to obtain intuitive
and measurable properties impactful properties. It facilitates the visualization
of coordination geometry from each site using four coordination determination
methods and extracts physics-based features like volume and packing
efficiency—crucial for structural analysis in machine learning tasks. Moreover,
`cifkit` extracts atomic mixing information at the bond pair level, tasks that
Expand Down Expand Up @@ -46,7 +47,9 @@ size, tags, coordination numbers, elements, and atomic mixing.

## Processing speed expectation

Processing approximately 10,000 .cif files on a standard laptop (iMac with M1 chip) may take about 30 to 60 minutes. At this rate, we can process nearly all .cif files within 1–2 days.
Processing approximately 10,000 .cif files on a standard laptop (iMac with M1
chip) may take about 30 to 60 minutes. At this rate, we can process nearly all
.cif files within 1–2 days.

## Installation

Expand Down
26 changes: 26 additions & 0 deletions package-lock.json

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

5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"prettier": "^3.3.3"
}
}
82 changes: 0 additions & 82 deletions paper-review-1.md

This file was deleted.

157 changes: 0 additions & 157 deletions paper-review-2.md

This file was deleted.

Loading
Loading