Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add references to JOSS paper #362

Merged
merged 4 commits into from
Oct 28, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,18 @@
:target: https://colab.research.google.com/github/lanl/scico-data/blob/colab/notebooks/index.ipynb
:alt: Run notebooks on google colab

.. image:: https://joss.theoj.org/papers/10.21105/joss.04722/status.svg
:target: https://doi.org/10.21105/joss.04722
:alt: JOSS paper



Scientific Computational Imaging COde (SCICO)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest changing this to Scientific Computational Imaging Code (SCICO) as in the paper

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

=============================================

SCICO is a Python package for solving the inverse problems that arise in scientific imaging applications. Its primary focus is providing methods for solving ill-posed inverse problems by using an appropriate prior model of the reconstruction space. SCICO includes a growing suite of operators, cost functionals, regularizers, and optimization routines that may be combined to solve a wide range of problems, and is designed so that it is easy to add new building blocks. SCICO is built on top of `JAX <https://github.com/google/jax>`_, which provides features such as automatic gradient calculation and GPU acceleration.

`Documentation <https://scico.rtfd.io/>`_ is available online. If you use this software for published work, please cite bibtex entry ``scico-2022`` in ``docs/source/references.bib``.
`Documentation <https://scico.rtfd.io/>`_ is available online. If you use this software for published work, please cite the corresponding `JOSS Paper <https://doi.org/10.21105/joss.04722>`_ (see bibtex entry ``balke-2022-scico`` in ``docs/source/references.bib``).


Installation
Expand Down
2 changes: 1 addition & 1 deletion docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ and `binder
<https://mybinder.org/v2/gh/lanl/scico-data/binder?labpath=notebooks%2Findex.ipynb>`__.


If you use this library for published work, please cite :cite:`scico-2022` (see bibtex entry ``scico-2022`` in `docs/source/references.bib <https://github.com/lanl/scico/blob/main/docs/source/references.bib>`_ in the source distribution).
If you use this library for published work, please cite :cite:`balke-2022-scico` (see bibtex entry ``balke-2022-scico`` in `docs/source/references.bib <https://github.com/lanl/scico/blob/main/docs/source/references.bib>`_ in the source distribution).



Expand Down
20 changes: 11 additions & 9 deletions docs/source/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -481,15 +481,17 @@ @Article {sauer-1993-local
doi = {10.1109/78.193196}
}

@Misc {scico-2022,
author = {Thilo Balke and Fernando Davis and
Cristina Garcia-Cardona and Michael McCann and
Luke Pfister and Brendt Wohlberg},
title = {{S}cientific {C}omputational {I}maging {CO}de
{(SCICO)}},
howpublished = {Software library available from
\url{https://github.com/lanl/scico}},
year = 2022
@Article {balke-2022-scico,
author = {Thilo Balke and Fernando Davis and Cristina
Garcia-Cardona and Soumendu Majee and Michael McCann
and Luke Pfister and Brendt Wohlberg},
title = {Scientific Computational Imaging Code ({SCICO})},
journal = {Journal of Open Source Software},
year = {2022},
volume = {7},
number = {78},
pages = {4722},
doi = {10.21105/joss.04722}
}

@Article {soulez-2016-proximity,
Expand Down