Skip to content

Commit

Permalink
CI: Add conda-forge channel
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Nov 6, 2018
1 parent 89a080a commit bcc2117
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
28 changes: 21 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ for more information.
Installation
============

``crystals`` can be installed from source::
``crystals`` is available on the Python Package Index::

pip install crystals

``crystals`` can also be installed from source::

git clone https://github.com/LaurentRDC/crystals.git
cd crystals
Expand All @@ -35,30 +39,40 @@ You can install the latest development version using ``pip`` as well::

python -m pip install git+git://github.com/LaurentRDC/crystals.git

``crystals`` is also available on the Python Package Index::
To build documentation, you will need a few more packages, listed in ``dev-requirements.txt``. For example, to build documentation from source::

pip install crystals
git clone https://github.com/LaurentRDC/crystals.git
cd crystals
pip install -r dev-requirements.txt
python setup.py build_sphinx

Documentation
=============

The documentation, including a user guide as well as detailed reference, is available here: https://crystals.readthedocs.io/

Citations
---------
=========

If you find this software useful, please consider citing the following publication:

.. [#] L. P. René de Cotret, M. R. Otto, M. J. Stern. and B. J. Siwick, *An open-source software ecosystem for the interactive
exploration of ultrafast electron scattering data*, Advanced Structural and Chemical Imaging **4**:11 (2018) DOI: 10.1186/s40679-018-0060-y
Underlying algorithms provided by ``spglib`` are described in the following publication:


Aknowledgements
===============

This package depends on the work of some amazing people. Of note are the `spglib contributors <https://github.com/atztogo/spglib>`_
Support / Report Issues
-----------------------
=======================

All support requests and issue reports should be `filed on Github as an issue <https://github.com/LaurentRDC/crystals/issues>`_.

License
-------
=======

``crystals`` is made available under the BSD 3-clause license. For more details, see `LICENSE.txt <https://github.com/LaurentRDC/crystals/blob/master/LICENSE.txt>`_.

Expand All @@ -72,7 +86,7 @@ Tests can be run with the standard library's `unittest` module::
Some optional tests might be skipped if dependencies are not installed, e.g. `ASE`.

Related projects
----------------
================

- Streaming operations on NumPy arrays are available in the `npstreams package <https://pypi.org/pypi/npstreams>`_.

Expand Down
1 change: 1 addition & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ environment:
# to the matrix section.
TEST_CMD: "python -m unittest discover --verbose"
NUMPY_VERSION: "1.14"
CONDA_CHANNELS: "conda-forge"
CONDA_DEPENDENCIES: "numpy spglib pycifrw ase"
PIP_DEPENDENCIES: ""

Expand Down
11 changes: 0 additions & 11 deletions docs/spelling_wordlist.txt

This file was deleted.

0 comments on commit bcc2117

Please sign in to comment.