Skip to content

Commit

Permalink
Add getting started section and re-arrange install success check inst…
Browse files Browse the repository at this point in the history
…ructions (#113)
  • Loading branch information
bobleesj authored Oct 22, 2024
1 parent 2f1140e commit 944e13d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 7 deletions.
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__)"

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
---------------

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>

0 comments on commit 944e13d

Please sign in to comment.