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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ by citing the following paper in your publication:
<https://doi.org/10.1038/s41524-024-01377-5>`__,
*npj Comput Mater* **10**, 193 (2024).


Installation
------------

Expand All @@ -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.


The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``diffpy.snmf_env`` environment, type ::
Expand All @@ -89,13 +94,10 @@ and run the following ::

pip install .

To confirm that the installation was successful, type ::

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

---------------

Now, you may consult our `online documentation <https://diffpy.github.io/diffpy.snmf>`_ for tutorials and API references.
You may consult our `online documentation <https://diffpy.github.io/diffpy.snmf>`_ for tutorials and API references.

Support and Contribute
----------------------
Expand Down
23 changes: 23 additions & 0 deletions news/update-install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

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

**Security:**

* <news item>