From fbba931ddee08b979b5f4e9655d0eeea0340f1eb Mon Sep 17 00:00:00 2001 From: Duncan Johnstone Date: Wed, 24 Jul 2019 09:11:01 +0100 Subject: [PATCH 1/3] fix appveyor --- appveyor.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/appveyor.yml b/appveyor.yml index b9ceb438..2c5895a6 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -10,16 +10,14 @@ environment: - PY_VERSION: 3.6 # scripts that run after cloning repository install: - # Workaround for https://github.com/conda/conda/issues/7144 - # see https://github.com/appveyor/ci/issues/2270 - - set PATH=C:\Miniconda37-x64;C:\Miniconda37-x64\Scripts;%PATH% - # Activate miniconda root environment - - "C:\\Miniconda37-x64\\Scripts\\activate.bat" + - "CALL C:\\Miniconda37-x64\\Scripts\\activate.bat" # Setup miniconda environment. - ps: Add-AppveyorMessage "Setup miniconda environment..." - "conda update -y -n base conda" + # See https://github.com/conda/conda/issues/8836 & others + - set "PATH=%MINICONDA%\condabin:%PATH%" - 'conda config --add channels conda-forge' - "conda create -y -n testenv python=%PY_VERSION%" - "conda activate testenv" From 81c9d658c3cc5d772e38bcc5b5c24981ba9f9e21 Mon Sep 17 00:00:00 2001 From: Duncan Johnstone Date: Wed, 24 Jul 2019 09:15:13 +0100 Subject: [PATCH 2/3] bump version to 0.1.4 --- diffsims/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/diffsims/version.py b/diffsims/version.py index 8fd1c5ad..70a5fdda 100644 --- a/diffsims/version.py +++ b/diffsims/version.py @@ -2,7 +2,7 @@ __copyright__ = "Copyright 2017-2019, Diffraction Simulations in Python" __credits__ = ["Duncan Johnstone", "Phillip Crout", "Ben Martineau", "Simon Hogas"] __license__ = "GPL" -__version__ = "0.1.3" +__version__ = "0.1.4" __maintainer__ = "Duncan Johnstone" __email__ = "dnj23@cam.ac.uk" __status__ = "Development" From 8a7be4511c1cd4aaedf8706f5e4c8748e757cc5e Mon Sep 17 00:00:00 2001 From: Duncan Johnstone Date: Wed, 24 Jul 2019 13:06:41 +0100 Subject: [PATCH 3/3] add install instructions to readme --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index 50d4add6..2bbd11ae 100644 --- a/README.rst +++ b/README.rst @@ -21,3 +21,20 @@ diffsims is an open-source python library for simulating diffraction. If simulations performed using diffsims form a part of published work please cite the DOI at the top of this page. diffsims is released under the GPL v3 license. + + +Installation +------------ + +diffsims requires python 3 and conda - we suggest using the python 3 version of `Miniconda `__ and creating a new environment for diffsims using the following commands in the anaconda prompt::: + + $ conda create -n diffsims + $ conda activate diffsims + +The recommended way to install diffsims is then from conda-forge using::: + + $ conda install -c conda-forge diffsims + +Note that diffsims is also available via pip::: + + $ pip install diffsims