Commit f6702c41 authored by Martin Reinecke's avatar Martin Reinecke

move citations into documentation and link from README.md

parent 6b02ddc4
Pipeline #26241 canceled with stage
in 5 minutes and 56 seconds
......@@ -4,7 +4,7 @@ NIFTy - Numerical Information Field Theory
[![coverage report](https://gitlab.mpcdf.mpg.de/ift/NIFTy/badges/NIFTy_4/coverage.svg)](https://gitlab.mpcdf.mpg.de/ift/NIFTy/commits/NIFTy_4)
**NIFTy** project homepage:
[http://ift.pages.mpcdf.de/NIFTy](http://ift.pages.mpcdf.de/NIFTy)
[https://ift.pages.mpcdf.de/NIFTy](https://ift.pages.mpcdf.de/NIFTy)
Summary
-------
......@@ -110,66 +110,24 @@ following command in the repository root:
### First Steps
For a quick start, you can browse through the [informal
introduction](http://ift.pages.mpcdf.de/NIFTy/code.html) or
introduction](https://ift.pages.mpcdf.de/NIFTy/code.html) or
dive into NIFTy by running one of the demonstrations, e.g.:
python demos/wiener_filter_via_curvature.py
Acknowledgement
---------------
### Acknowledgement
Please acknowledge the use of NIFTy in your publication(s) by using a
phrase such as the following:
> *"Some of the results in this publication have been derived using the
> NIFTy package [Steininger et al., 2017]."[1]
Or one of the following BibTeX entries:
@software{nifty,
author = {{Martin Reinecke, Theo Steininger, Marco Selig}},
title = {NIFTy -- Numerical Information Field TheorY},
url = {https://gitlab.mpcdf.mpg.de/ift/NIFTy},
version = {nifty4},
date = {2018-04-05},
}
@ARTICLE{2013A&A...554A..26S,
author = {{Selig}, M. and {Bell}, M.~R. and {Junklewitz}, H. and {Oppermann}, N. and {Reinecke}, M. and {Greiner}, M. and {Pachajoa}, C. and {En{\ss}lin}, T.~A.},
title = "{NIFTY - Numerical Information Field Theory. A versatile PYTHON library for signal inference}",
journal = {\aap},
archivePrefix = "arXiv",
eprint = {1301.4499},
primaryClass = "astro-ph.IM",
keywords = {methods: data analysis, methods: numerical, methods: statistical, techniques: image processing},
year = 2013,
month = jun,
volume = 554,
eid = {A26},
pages = {A26},
doi = {10.1051/0004-6361/201321236},
adsurl = {http://cdsads.u-strasbg.fr/abs/2013A%26A...554A..26S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@ARTICLE{2017arXiv170801073S,
author = {{Steininger}, T. and {Dixit}, J. and {Frank}, P. and {Greiner}, M. and {Hutschenreuter}, S. and {Knollm{\"u}ller}, J. and {Leike}, R. and {Porqueres}, N. and {Pumpe}, D. and {Reinecke}, M. and {{\v S}raml}, M. and {Varady}, C. and {En{\ss}lin}, T.},
title = "{NIFTy 3 - Numerical Information Field Theory - A Python framework for multicomponent signal inference on HPC clusters}",
journal = {ArXiv e-prints},
archivePrefix = "arXiv",
eprint = {1708.01073},
primaryClass = "astro-ph.IM",
keywords = {Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2017,
month = aug,
adsurl = {http://cdsads.u-strasbg.fr/abs/2017arXiv170801073S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
### References
Release Notes
-------------
> NIFTy package [(https://gitlab.mpcdf.mpg.de/ift/NIFTy)](https://gitlab.mpcdf.mpg.de/ift/NIFTy)"
and a citation to one of the [publications](https://ift.pages.mpcdf.de/NIFTy/citations.html)
### Release Notes
The NIFTy package is licensed under the terms of the
[GPLv3](https://www.gnu.org/licenses/gpl.html) and is distributed
......
NIFTy-related publications
==========================
::
@software{nifty,
author = {{Martin Reinecke, Theo Steininger, Marco Selig}},
title = {NIFTy -- Numerical Information Field TheorY},
url = {https://gitlab.mpcdf.mpg.de/ift/NIFTy},
version = {nifty4},
date = {2018-04-05},
}
@ARTICLE{2013A&A...554A..26S,
author = {{Selig}, M. and {Bell}, M.~R. and {Junklewitz}, H. and {Oppermann}, N. and {Reinecke}, M. and {Greiner}, M. and {Pachajoa}, C. and {En{\ss}lin}, T.~A.},
title = "{NIFTY - Numerical Information Field Theory. A versatile PYTHON library for signal inference}",
journal = {\aap},
archivePrefix = "arXiv",
eprint = {1301.4499},
primaryClass = "astro-ph.IM",
keywords = {methods: data analysis, methods: numerical, methods: statistical, techniques: image processing},
year = 2013,
month = jun,
volume = 554,
eid = {A26},
pages = {A26},
doi = {10.1051/0004-6361/201321236},
adsurl = {http://cdsads.u-strasbg.fr/abs/2013A%26A...554A..26S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
@ARTICLE{2017arXiv170801073S,
author = {{Steininger}, T. and {Dixit}, J. and {Frank}, P. and {Greiner}, M. and {Hutschenreuter}, S. and {Knollm{\"u}ller}, J. and {Leike}, R. and {Porqueres}, N. and {Pumpe}, D. and {Reinecke}, M. and {{\v S}raml}, M. and {Varady}, C. and {En{\ss}lin}, T.},
title = "{NIFTy 3 - Numerical Information Field Theory - A Python framework for multicomponent signal inference on HPC clusters}",
journal = {ArXiv e-prints},
archivePrefix = "arXiv",
eprint = {1708.01073},
primaryClass = "astro-ph.IM",
keywords = {Astrophysics - Instrumentation and Methods for Astrophysics},
year = 2017,
month = aug,
adsurl = {http://cdsads.u-strasbg.fr/abs/2017arXiv170801073S},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
......@@ -25,6 +25,7 @@ Contents
Gallery <http://wwwmpa.mpa-garching.mpg.de/ift/nifty/gallery/>
installation
code
citations
Indices and tables
..................
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment