Skip to content

Commit

Permalink
Fixed README rendering on Pypitest
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Jun 21, 2017
1 parent 0fc33db commit 9ce8dea
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 47 deletions.
43 changes: 0 additions & 43 deletions README.md

This file was deleted.

54 changes: 54 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
scikit-ued
==========

.. image:: https://img.shields.io/appveyor/ci/LaurentRDC/scikit-ued/master.svg
:target: https://ci.appveyor.com/project/LaurentRDC/scikit-ued
:alt: Windows Build Status
.. image:: https://readthedocs.org/projects/scikit-ued/badge/?version=latest
:target: http://scikit-ued.readthedocs.io
:alt: Documentation Build Status
.. image:: https://img.shields.io/pypi/v/scikit-ued.svg
:target: https://pypi.python.org/pypi/scikit-ued
:alt: PyPI Version

Collection of algorithms and functions for ultrafast electron diffraction.

Getting Started with scikit-ued
-------------------------------

scikit-ued is available on PyPI can be installed with `pip <https://pip.pypa.io>`_.::

$ python -m pip install scikit-ued

To install the latest development version from `Github <https://github.com/LaurentRDC/scikit-ued>`_::

$ python -m pip install git+git://github.com/LaurentRDC/scikit-ued.git

Each version is tested against Python 3.5 and 3.6. If you are using a different version, tests can be run
using the standard library's `unittest` module.

After installing scikit-ued you can use it like any other Python module as :code:`skued`.

Citations
---------

If you are using the :code:`skued.baseline` subpackage, consider citing the following publication:

.. [#] L. P. René de Cotret and B. J. Siwick, A general method for baseline-removal in ultrafast
electron powder diffraction data using the dual-tree complex wavelet transform, Struct. Dyn. 4 (2017) DOI: 10.1063/1.4972518.
API Reference
-------------

The `API Reference on readthedocs.io <http://scikit-ued.readthedocs.io>`_ provides API-level documentation.

Support / Report Issues
-----------------------

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

License
-------

scikit-ued is made available under the MIT License. For more details, see `LICENSE.txt <https://github.com/LaurentRDC/scikit-ued/blob/master/LICENSE.txt>`_.
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ max-line-length=120
universal = 0

[metadata]
description-file = README.md
description-file = README.rst
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
LICENSE = re.compile(r'.*__license__ = \'(.*?)\'', re.S).match(module_content).group(1)


with open('README.md') as f:
with open('README.rst') as f:
readme = f.read()

with open('requirements.txt') as f:
Expand All @@ -42,7 +42,7 @@
setup(
name = 'scikit-ued',
description = 'Collection of algorithms and functions for ultrafast electron diffraction',
long_description = '\n\n'.join(readme),
long_description = readme,
license = LICENSE,
url = 'http://scikit-ued.readthedocs.io',
download_url = 'http://github.com/LaurentRDC/scikit-ued',
Expand Down
2 changes: 1 addition & 1 deletion skued/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
__author__ = 'Laurent P. René de Cotret'
__email__ = 'laurent.renedecotret@mail.mcgill.ca'
__license__ = 'MIT'
__version__ = '0.4.4.1' # TODO: automatic versioning?
__version__ = '0.4.4.2' # TODO: automatic versioning?

from .affine import (affine_map, change_basis_mesh, change_of_basis, is_basis,
is_rotation_matrix, minimum_image_distance,
Expand Down

0 comments on commit 9ce8dea

Please sign in to comment.