From 20c669c4ae3d42f2e89c473fade17fbd5133cd39 Mon Sep 17 00:00:00 2001 From: Ruben Verweij Date: Tue, 14 Feb 2017 17:05:42 +0100 Subject: [PATCH] Rebranding in anticipation of better metadata support (mainly for FRAP experiments). --- CONTRIBUTING.md | 4 ++-- CONTRIBUTORS.txt | 4 +++- README.md | 13 +++---------- setup.py | 8 ++++---- 4 files changed, 12 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 973c716..192eea0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing to nd2reader -We welcome feature proposals and improvements to the library from anyone. If you just have an idea, you can open an [issue](https://github.com/jimrybarski/nd2reader/issues) for -discussion, or get in touch with Jim Rybarski via email at jim@rybarski.com, or on Twitter at [@jimrybarski](https://twitter.com/jimrybarski). If you already wrote some code or made changes, simply open a pull +We welcome feature proposals and improvements to the library from anyone. If you just have an idea, you can open an [issue](https://github.com/rbnvrw/nd2reader/issues) for +discussion, or get in touch with Ruben Verweij. If you already wrote some code or made changes, simply open a pull request. ## Running and Writing Tests diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 1b0a856..363b9f5 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -1,4 +1,6 @@ Author: Jim Rybarski nd2reader is based on the read_nd2 module from the SLOTH library (http://pythonhosted.org/SLOTH/_modules/sloth/read_nd2.html). -Thanks to M.Kauer and B.Kauer for solving the hardest part of parsing ND2s. \ No newline at end of file +Thanks to M.Kauer and B.Kauer for solving the hardest part of parsing ND2s. + +This fork is maintained by Ruben Verweij. \ No newline at end of file diff --git a/README.md b/README.md index 374cd6b..9a1ed6a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,5 @@ # nd2reader -### Don't use this library, use Micro-Manager - -I am no longer supporting this library, as my lab has discovered [Micro-Manager](https://micro-manager.org/) and found it to be a far superior application for acquiring microscope data. I would highly recommend switching if it works for what you're doing. - -I will not be accepting pull requests any longer. If you find a bug, you can fork the repo and fix it yourself, or look for someone else's fork which may already contain a fix. -If you would like to take control of the nd2reader namespace on PyPI, please shoot me an email. I'm not going to just give it away but I will consider it for someone who produces a high-quality fork that's widely-used. - ### About `nd2reader` is a pure-Python package that reads images produced by NIS Elements 4.0+. It has only been definitively tested on NIS Elements 4.30.02 Build 1053. Support for older versions is being actively worked on. @@ -128,12 +121,12 @@ The `Nd2` object has some programmatically-accessible metadata: ### Contributing -If you'd like to help with the development of nd2reader or just have an idea for improvement, please see the [contributing](https://github.com/jimrybarski/nd2reader/blob/master/CONTRIBUTING.md) page +If you'd like to help with the development of nd2reader or just have an idea for improvement, please see the [contributing](https://github.com/rbnvrw/nd2reader/blob/master/CONTRIBUTING.md) page for more information. ### Bug Reports and Features -If this fails to work exactly as expected, please open an [issue](https://github.com/jimrybarski/nd2reader/issues). +If this fails to work exactly as expected, please open an [issue](https://github.com/rbnvrw/nd2reader/issues). If you get an unhandled exception, please paste the entire stack trace into the issue as well. ### Citation @@ -147,4 +140,4 @@ http://dx.doi.org/10.6084/m9.figshare.1619960 ### Acknowledgments -Support for the development of this package was provided by the [Finkelstein Laboratory](http://finkelsteinlab.org/). +Original version by Jim Rybarski. Support for the development of this package was provided by the [Finkelstein Laboratory](http://finkelsteinlab.org/). diff --git a/setup.py b/setup.py index 7782e75..89d5aa3 100644 --- a/setup.py +++ b/setup.py @@ -13,10 +13,10 @@ if __name__ == '__main__': ], version=VERSION, description='A tool for reading ND2 files produced by NIS Elements', - author='Jim Rybarski', - author_email='jim@rybarski.com', - url='https://github.com/jimrybarski/nd2reader', - download_url='https://github.com/jimrybarski/nd2reader/tarball/%s' % VERSION, + author='Ruben Verweij', + author_email='verweij@physics.leidenuniv.nl', + url='https://github.com/rbnvrw/nd2reader', + download_url='https://github.com/rbnvrw/nd2reader/tarball/%s' % VERSION, keywords=['nd2', 'nikon', 'microscopy', 'NIS Elements'], classifiers=['Development Status :: 5 - Production/Stable', 'Intended Audience :: Science/Research',