From 925582a260f6e49271ce185870784bdce44cae1b Mon Sep 17 00:00:00 2001 From: Arthur Vigan Date: Tue, 7 Apr 2020 13:52:12 +0200 Subject: [PATCH 1/6] Prepare pyzelda for availability through pip --- setup.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index b23514a..311914b 100644 --- a/setup.py +++ b/setup.py @@ -2,8 +2,7 @@ setup( name='pyZELDA', - version='1.0', - + version='1.1', description='Zernike wavefront sensor analysis and simulation tools', url='https://github.com/avigan/pyZELDA', author='Arthur Vigan & Mamadou N\'Diaye', @@ -11,7 +10,7 @@ license='MIT', classifiers=[ 'Development Status :: 5 - Production/Stable', - 'Intended Audience :: Professional Astronomers', + 'Intended Audience :: Science/Research ', 'Topic :: Wavefront Sensing', 'Programming Language :: Python :: 3', 'License :: OSI Approved :: MIT License' From aaa17f08fa39138a9b4104f7ce51cf1beb74b559 Mon Sep 17 00:00:00 2001 From: Arthur Vigan Date: Tue, 7 Apr 2020 15:37:35 +0200 Subject: [PATCH 2/6] Add requirements and installation instructions to README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 3a57656..811ca90 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,27 @@ The formalism of the Zernike wavefront sensor and the demonstration of its capab - [N'Diaye, Vigan, Dohlen et al., 2016, A&A, 592, A79](https://ui.adsabs.harvard.edu/#abs/2016A&A...592A..79N/abstract) - [Vigan, N'Diaye, Dohlen et al., 2019, A&A, 629, A11](https://ui.adsabs.harvard.edu/abs/2019A%26A...629A..11V/abstract) +Requirements +------------ + +The package relies on usual packages for data science and astronomy: [numpy](https://numpy.org/), [scipy](https://www.scipy.org/), [matplotlib](https://matplotlib.org/) and [astropy](https://www.astropy.org/). + +Installation +------------ + +The easiest is to install `pyzelda` using `pip`: + +```sh +pip install pyzelda +``` + +Otherwise your can download the current repository and install the package manually: + +```sh +cd pyZELDA-master/ +python setup.py install +``` + Citation -------- From 5601754e276c395512384cf52d1fa8eb741675a7 Mon Sep 17 00:00:00 2001 From: Arthur Vigan Date: Tue, 7 Apr 2020 15:37:52 +0200 Subject: [PATCH 3/6] Minor fix on setup string --- setup.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 311914b..a728c7e 100644 --- a/setup.py +++ b/setup.py @@ -1,11 +1,19 @@ from setuptools import setup +# read the contents of your README file +from os import path +this_directory = path.abspath(path.dirname(__file__)) +with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + setup( - name='pyZELDA', + name='pyzelda', version='1.1', description='Zernike wavefront sensor analysis and simulation tools', + long_description=long_description, + long_description_content_type='text/markdown', url='https://github.com/avigan/pyZELDA', - author='Arthur Vigan & Mamadou N\'Diaye', + author="Arthur Vigan & Mamadou N'Diaye", author_email='arthur.vigan@lam.fr, mamadou.ndiaye@oca.eu', license='MIT', classifiers=[ From 14ac7aab512b5fdf7f6156d63d13c21ddf8c93f3 Mon Sep 17 00:00:00 2001 From: Arthur Vigan Date: Tue, 7 Apr 2020 15:52:44 +0200 Subject: [PATCH 4/6] Add basic information into __init__ file --- pyzelda/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pyzelda/__init__.py b/pyzelda/__init__.py index e69de29..bf8f971 100644 --- a/pyzelda/__init__.py +++ b/pyzelda/__init__.py @@ -0,0 +1,3 @@ +__author__ = "Arthur Vigan, Mamadou N'Diaye" +__license__ = 'MIT' +__version__ = '1.1' From 99556a0fdb281ea8399f814884b363cd92f961a8 Mon Sep 17 00:00:00 2001 From: Arthur Vigan Date: Tue, 7 Apr 2020 15:54:07 +0200 Subject: [PATCH 5/6] Add direct access to Sensor object from pyzelda root module --- pyzelda/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pyzelda/__init__.py b/pyzelda/__init__.py index bf8f971..af0a2dc 100644 --- a/pyzelda/__init__.py +++ b/pyzelda/__init__.py @@ -1,3 +1,6 @@ __author__ = "Arthur Vigan, Mamadou N'Diaye" __license__ = 'MIT' __version__ = '1.1' + +# direct access to sensor object +from .zelda import Sensor From 58410afcb340bd6996346a2ef8ce753ff59e4b81 Mon Sep 17 00:00:00 2001 From: Arthur Vigan Date: Tue, 7 Apr 2020 15:57:09 +0200 Subject: [PATCH 6/6] Add copyright to __init__ --- pyzelda/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/pyzelda/__init__.py b/pyzelda/__init__.py index af0a2dc..1b2ce37 100644 --- a/pyzelda/__init__.py +++ b/pyzelda/__init__.py @@ -1,4 +1,5 @@ __author__ = "Arthur Vigan, Mamadou N'Diaye" +__copyright__ = "Copyright (C) 2017-2020 Arthur Vigan, Mamadou N'Diaye" __license__ = 'MIT' __version__ = '1.1'