Skip to content

Commit b3a799c

Browse files
authored
Merge pull request #26 from cadenmyers13/cmi-functionality
docs: Section on community use and contribution
2 parents fcf9717 + 203ca14 commit b3a799c

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

doc/source/img/cmi_problem_types.png

90.1 KB
Loading

doc/source/index.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,33 @@
88
99
``diffpy.cmi`` - Complex modeling infrastructure: a modular framework for multi-modal modeling of scientific data.
1010

11-
DiffPy.CMI is our complex modeling framework. It is a highly flexible library of Python modules for robust modeling of nanostructures in crystals, nanomaterials, and amorphous materials.
11+
diffpy.cmi is designed as an extensible complex modeling infrastructure. Users and developers can readily integrate novel data types and constraints into custom workflows. While widely used for advanced analysis of structural data, the framework is general and can be applied to any problem where model parameters are refined to fit calculated quantities to data.
1212

13-
The software provides functionality for storage and manipulation of structure data and calculation of structure-based quantities, such as PDF, SAS, bond valence sums, atom overlaps, bond lengths, and coordinations. Most importantly the diffpy.cmi package contains a fitting framework for combining multiple experimental inputs in a single optimization problem.
13+
diffpy.cmi is a community-driven project that supports Unix, Linux, macOS, and Windows platforms. It is designed to be used in Python scripts enabling flexible scripting and automation for advanced and reproducible workflows. Users are encouraged to leverage the software for their modeling needs and to contribute feedback, use cases, and extensions through the project community.
1414

1515
.. image:: ./img/diffpycmi_screenshot.png
1616
:alt: codecov-in-pr-comment
1717
:width: 400px
1818
:align: center
1919

20+
=======================================
21+
Community Use and Extensible Modeling
22+
=======================================
23+
24+
One of the key strengths of ``diffpy.cmi`` is its modular design, which allows the integration and fitting of *any* data type, not just PDFs.
25+
While its current core functionality is in PDF modeling and multi-dataset fitting, **we actively encourage and support community-developed modules and workflows for any data types you see fit!**
26+
27+
.. image:: ./img/cmi_problem_types.png
28+
:alt: codecov-in-pr-comment
29+
:width: 500px
30+
:align: center
31+
32+
Have you built a new workflow you'd like to implement into ``diffpy.cmi``?
33+
We would love to **highlight your extension or application!**
34+
35+
1. **Share your work:** Please `open an issue or a pull request <https://github.com/diffpy/diffpy.cmi>`_ to share your work and help us expand the platform.
36+
2. **Be recognized:** Community contributions and new use cases will be showcased and credited here.
37+
2038
===============
2139
Getting started
2240
===============

news/cmi-functionality.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**Added:**
2+
3+
* Add section to docs for community-driven modules.
4+
5+
**Changed:**
6+
7+
* <news item>
8+
9+
**Deprecated:**
10+
11+
* <news item>
12+
13+
**Removed:**
14+
15+
* <news item>
16+
17+
**Fixed:**
18+
19+
* <news item>
20+
21+
**Security:**
22+
23+
* <news item>

0 commit comments

Comments
 (0)