chore: add long description to readme #24
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24 +/- ##
=======================================
Coverage 75.67% 75.67%
=======================================
Files 3 3
Lines 37 37
=======================================
Hits 28 28
Misses 9 9 🚀 New features to boost your workflow:
|
README.rst
Outdated
| @@ -37,7 +37,9 @@ | |||
|
|
|||
| Complex modeling infrastructure: a modulare framework for multi-modal modeling of scientific data. | |||
|
|
|||
| * LONGER DESCRIPTION HERE | |||
| 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. | |||
There was a problem hiding this comment.
remember, this is in high level othing to do with structure.....it is a regression engine. You could use it for making stock picks if you wanted....
README.rst
Outdated
| * LONGER DESCRIPTION HERE | ||
| 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. | ||
|
|
||
| This is an early release of code that is under intense development, with support for installation on Unix, Linux, and Macintosh machines. The scope and documentation of the project will evolve rapidly, but we want to make the code available at the earliest possible date. Please make use of the software and provide feedback and suggestions for improvement, but please be patient and check back frequently for updates. |
There was a problem hiding this comment.
this is not an early release....it is pretty mature. Though we are still developing it. If you want to mention that it is currently a library and doesn't have a well developed user interface, you could mention that.
|
@sbillinge Addressed your comments |
|
very nicely done there. Let's make the docs also have this flavor. tbh we might like to hvae some examples that are not structure related. Pavol has a Gaussian fit to a curve, but this is not enough to adopt cmi as there are many packages out there to do things like that now (though it remains a good pedagogical example). Not a rush priority, but let's try and think of a non-structure related example. |
closes #11