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

Addressing Issue 85 #87

Merged
merged 7 commits into from
Apr 1, 2024
Merged

Addressing Issue 85 #87

merged 7 commits into from
Apr 1, 2024

Conversation

cadenmyers13
Copy link
Contributor

@cadenmyers13 cadenmyers13 commented Mar 19, 2024

closes #85

Addressed:

Add --yes to conda create -n pdfmorph_env python=3 command
Remove duplicated conda config --add channels conda-forge
Change easy_install --update to pip
Replace travis badge with gh status badge

I believe bg-mpl-stylesheets is downloading properly as well.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice job. it looks fine. Please see my comments and push again.

README.rst Outdated
@@ -116,7 +112,7 @@ version using ::
With other Python distributions the program can be upgraded to
the latest version as follows ::

easy_install --upgrade diffpy.pdfmorph
pip install diffpy.pdfmorph
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be conda update, not pip.

@@ -77,7 +78,7 @@ conda and test that it is working by opening a terminal and typing
To create and activate a conda environment to use this software, run
the following command from the command line ::

conda create -n pdfmorph_env python=3
conda create -n pdfmorph_env python=3 --yes
source activate pdfmorph_env

If you're using Windows, replace ``source activate pdfmorph`` with
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please check this. I think that maybe this is no longer needed.

README.rst Show resolved Hide resolved
Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nearly there. I love the badge!

please see my one new comment and there is an unresolved one from before about commands on windows.

README.rst Outdated
@@ -116,7 +113,7 @@ version using ::
With other Python distributions the program can be upgraded to
the latest version as follows ::

easy_install --upgrade diffpy.pdfmorph
conda update diffpy.pdfmorph
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This strikes me as not correct based on the text just above. I suggest that we simply delete lines starting "with other python distributions......" and just leave instructions how to update the software using conda.

@cadenmyers13
Copy link
Contributor Author

cadenmyers13 commented Mar 26, 2024 via email

@sbillinge
Copy link
Contributor

sbillinge commented Mar 26, 2024 via email

Copy link

codecov bot commented Mar 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.33%. Comparing base (6fdf12b) to head (62ea1b1).
Report is 19 commits behind head on main.

❗ Current head 62ea1b1 differs from pull request most recent head 4430ba3. Consider uploading reports for the commit 4430ba3 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #87      +/-   ##
==========================================
+ Coverage   75.01%   84.33%   +9.32%     
==========================================
  Files          36       38       +2     
  Lines        1437     1890     +453     
==========================================
+ Hits         1078     1594     +516     
+ Misses        359      296      -63     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cadenmyers13 cadenmyers13 marked this pull request as draft March 26, 2024 18:11
Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. This is marked as draft. Are still working on this branch?

@cadenmyers13 cadenmyers13 requested a review from sbillinge April 1, 2024 19:16
@cadenmyers13
Copy link
Contributor Author

cadenmyers13 commented Apr 1, 2024 via email

@sbillinge sbillinge marked this pull request as ready for review April 1, 2024 22:36
@sbillinge sbillinge merged commit e98c1a3 into diffpy:main Apr 1, 2024
1 check passed
@sbillinge
Copy link
Contributor

Nice job, merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix readme installation instructions
2 participants