docs: update getting started page #25
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@sbillinge ready for review |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #25 +/- ##
=======================================
Coverage 75.67% 75.67%
=======================================
Files 3 3
Lines 37 37
=======================================
Hits 28 28
Misses 9 9 🚀 New features to boost your workflow:
|
|
I also added citation to the index.rst |
sbillinge
reviewed
Jul 29, 2025
doc/source/getting-started.rst
Outdated
| Installation | ||
| ------------ | ||
|
|
||
| To install ``diffpy.cmi``, create a new conda environment and install the package from the conda-forge channel. |
There was a problem hiding this comment.
do I need a new environment or I could install it in an existing one if I wanted? I think most people get that, and we use this wording a lot, but it does worry me a bit that it will send a message that this needs to be installed in its own environment.
There was a problem hiding this comment.
@sbillinge Added wording saying you can create a new env or activate and existing env
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #13
I added installation instructions, a link to the primer book, and a link to the data and worked examples repo https://github.com/Billingegroup/pdfttp_data. The installation instructions are for conda-forge.