Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
avigan committed Apr 7, 2020
2 parents 91ee368 + 58410af commit 395f9e3
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 5 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------

Expand Down
7 changes: 7 additions & 0 deletions pyzelda/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
__author__ = "Arthur Vigan, Mamadou N'Diaye"
__copyright__ = "Copyright (C) 2017-2020 Arthur Vigan, Mamadou N'Diaye"
__license__ = 'MIT'
__version__ = '1.1'

# direct access to sensor object
from .zelda import Sensor
17 changes: 12 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
from setuptools import setup

setup(
name='pyZELDA',
version='1.0',
# 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',
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='[email protected], [email protected]',
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'
Expand Down

0 comments on commit 395f9e3

Please sign in to comment.