From 9dbd1c33752e7879dc3c86386c00567e8792e6e8 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Mon, 21 Oct 2024 15:47:14 -0400 Subject: [PATCH] Update instructions in reamde for conda/pip install (#110) * Update conda forge and pip install instruction * Add news --- README.rst | 8 ++------ news/update-install.rst | 23 +++++++++++++++++++++++ 2 files changed, 25 insertions(+), 6 deletions(-) create mode 100644 news/update-install.rst diff --git a/README.rst b/README.rst index c30f8cf9..f1b0dd26 100644 --- a/README.rst +++ b/README.rst @@ -74,14 +74,10 @@ To add "conda-forge" to the conda channels, run the following in a terminal. :: We want to install our packages in a suitable conda environment. The following creates and activates a new environment named ``diffpy.snmf_env`` :: - conda create -n diffpy.snmf_env python=3 + conda create -n diffpy.snmf_env diffpy.snmf conda activate diffpy.snmf_env -Then, to fully install ``diffpy.snmf`` in our active environment, run :: - - conda install diffpy.snmf - -Another option is to use ``pip`` to download and install the latest release from +If the above does not work, you can use ``pip`` to download and install the latest release from `Python Package Index `_. To install using ``pip`` into your ``diffpy.snmf_env`` environment, type :: diff --git a/news/update-install.rst b/news/update-install.rst new file mode 100644 index 00000000..ba4c9630 --- /dev/null +++ b/news/update-install.rst @@ -0,0 +1,23 @@ +**Added:** + +* + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* Updated REAMDE instructions for pip and conda-forge install + +**Security:** + +*