Skip to content
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
17 changes: 17 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://conda.io/miniconda.html>`__ 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
8 changes: 3 additions & 5 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion diffsims/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"