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

Add getting started section and re-arrange install success check instructions #113

Merged
merged 1 commit into from
Oct 22, 2024

Conversation

bobleesj
Copy link
Contributor

@bobleesj bobleesj commented Oct 21, 2024

No description provided.

@@ -77,6 +76,12 @@ The following creates and activates a new environment named ``diffpy.snmf_env``
conda create -n diffpy.snmf_env diffpy.snmf
conda activate diffpy.snmf_env

To confirm that the installation was successful, type ::

python -c "import diffpy.snmf; print(diffpy.snmf.__version__)"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

As discussed today, run the install success check after conda install.

python -c "import diffpy.snmf; print(diffpy.snmf.__version__)"

The output should print the latest version displayed on the badges above.
Getting Started
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Getting Started as a new header

@bobleesj
Copy link
Contributor Author

@sbillinge ready for review - to be updated in the cookiecutter repo.

@sbillinge sbillinge merged commit 944e13d into diffpy:main Oct 22, 2024
3 checks passed
@bobleesj bobleesj deleted the update-install branch October 22, 2024 00:27
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.

2 participants