Skip to content

Commit

Permalink
Updated requirements and README
Browse files Browse the repository at this point in the history
  • Loading branch information
LaurentRDC committed Apr 22, 2017
1 parent dba97e1 commit 94e9732
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 21 deletions.
11 changes: 3 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ scikit-ued
:target: https://saythanks.io/to/LaurentRDC
:alt: Say Thanks to the Maintainers

Collection of algorithms and functions for ultrafast electron diffraction
Collection of algorithms and functions for ultrafast electron diffraction.

Getting Started with scikit-ued
----------------------------
Expand All @@ -43,12 +43,12 @@ To install the latest development version from `Github <https://github.com/Laure
If your current Python installation doesn't have pip available, try `get-pip.py <bootstrap.pypa.io>`_

After installing scikit-ued you can use it like any other Python module.
Here's a very simple example:
Soon, there'll be a simple example here:

.. code-block:: python
import skued
# Fill this section in with the common use-case.
# come back later, this package is empty
API Reference
-------------
Expand All @@ -63,11 +63,6 @@ All support requests and issue reports should be
Make sure to follow the template so your request may be as handled as quickly as possible.
Please respect contributors by not using personal contacts for support requests.

Contributing
------------

We happily welcome contributions, please see `our guide for Contributors <http://skued.readthedocs.io/en/latest/contributing.html>`_ for the best places to start and help.

License
-------

Expand Down
3 changes: 2 additions & 1 deletion dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
nose==1.3.7
coverage==4.3.1
codecov==2.0.5
Sphinx==1.5.1
Sphinx>=1.5.1
cython>=0.25
4 changes: 4 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
numpy>= 1.11.2
scipy>= 0.17
scikit-image
pywavelets>=0.5.2
14 changes: 2 additions & 12 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import os
import re
from setuptools import setup, find_packages
from Cython.Build import cythonize

base_package = 'skued'

Expand All @@ -21,15 +22,14 @@
with open('requirements.txt') as f:
requirements = [line for line in f.read().split('\n') if len(line.strip())]


packages = [base_package + '.' + x for x in find_packages(os.path.join(base_path, base_package))]
if base_package not in packages:
packages.append(base_package)


if __name__ == '__main__':
setup(
name='skued',
name='scikit-ued',
description='Collection of algorithms and functions for ultrafast electron diffraction',
long_description='\n\n'.join([readme, changes]),
license=LICENSE,
Expand All @@ -39,11 +39,6 @@
author_email='laurent.renedecotret@mail.mcgill.ca',
maintainer='Laurent P. René de Cotret',
maintainer_email='laurent.renedecotret@mail.mcgill.ca',
entry_points={
'console_scripts': [
'skued = skued.cli:main'
]
},
install_requires=requirements,
keywords=['skued'],
packages=packages,
Expand All @@ -52,11 +47,6 @@
'License :: OSI Approved :: MIT License',
'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6']
)
Empty file removed tests/__init__.py
Empty file.

0 comments on commit 94e9732

Please sign in to comment.