Commit df99b2ed authored by Yunus Sevinchan's avatar Yunus Sevinchan
Browse files

Merge branch 'add-joss-paper' into 'master' 

Add JOSS Paper

Closes #175 and #194

See merge request utopia/dantro!163
parents 691e642b a59c2c10

CHANGELOG.md

+1 −0
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ 
  Skipping is triggered via a custom `SkipPlot` exception, that users may raise in their plot functions.

  Additionally, the `MultiversePlotCreator` allows skipping a plot if the dimensionality of the associated multiverse is not in a set of expected dimensionalities.

- Documentation:

    - !163 adds the paper published in the [Journal of Open Source Software](https://joss.theoj.org) and corresponding information on how to cite it.

    - !187 adds links to the source files from which example code is included into the documentation.

    - !189 improves the names of the introductory guides, as proposed in #190.

    - !190 makes using the IPython directive possible, simplifying the embedding of code examples, addressing #188.

CITATION.cff

0 → 100644
+43 −0
Original line number Diff line number Diff line 
# YAML 1.2

---

cff-version: "1.1.0"

message: If you use this software, please cite it using these metadata.



# JOSS publication information (also see: joss/paper.md )

title: "dantro: a Python package for handling, transforming, and visualizing hierarchically structured data"

doi: 10.21105/joss.02316

# TODO Add date-released, once available



authors:

  - given-names: Yunus

    family-names: Sevinchan

    orcid: https://orcid.org/0000-0003-3858-0904

    affiliation: Institute of Environmental Physics, Heidelberg University, Germany



  - given-names: Benjamin

    family-names: Herdeanu

    orcid: https://orcid.org/0000-0001-6343-3004

    affiliation: Institute of Environmental Physics, Heidelberg University, Germany



  - given-names: Jeremias

    family-names: Traub

    orcid: https://orcid.org/0000-0001-8911-6365

    affiliation: Institute of Environmental Physics, Heidelberg University, Germany



# Other package-related metadata

version: v0.14

license: LGPL-3.0+

repository-code: https://ts-gitlab.iup.uni-heidelberg.de/utopia/dantro

keywords:

  - Python

  - YAML

  - computer simulations

  - research software

  - data analysis

  - plotting

  - data processing pipeline

  - configuration-based interfaces

  - hierarchical data structures

  - HDF5



...

CONTRIBUTING.md

+4 −0
Original line number Diff line number Diff line
@@ -11,6 +11,10 @@ The dantro package is open source software. 
We thus strive to make every stage of development public, sharing our advances, and incorporating community contributions.

To achieve this transparency, we coordinate the whole process openly via this GitLab project.



The dantro package is licensed under the [GNU Lesser General Public License Version 3](https://www.gnu.org/licenses/lgpl-3.0.en.html).

As a contributor to the project and source code you agree that your contributions are published and may be distributed according to this license.

At your discretion you can be acknowledged in the [list of copyright holders](README.md#copyright-holders); please use your first contribution to dantro to inform us about your choice.



In brief, to contribute to dantro, the following steps are involved:



1. [Get access](#gitlab-account) to the dantro GitLab project

README.md

+4 −1
Original line number Diff line number Diff line
@@ -18,7 +18,8 @@ Furthermore, it allows a **configuration-based specification** of all operations 
The `dantro` package is **open source software** released under the LGPLv3+ license (see [copyright notice](#copyright) below).

It was developed alongside the [Utopia project][utopia-project], but is an independent package.



For more information on `dantro`, its features, philosophy, and integration, please visit its **documentation** at [`dantro.readthedocs.io`][dantro-docs].

We describe the motivation and scope of `dantro` in more detail in [this publication in the Journal of Open Source Software][dantro-joss-doi].

For more information on the package, its features, philosophy, and integration, please visit its **documentation** at [`dantro.readthedocs.io`][dantro-docs].

If you encounter any issues with `dantro` or have suggestions or questions of any kind, please open an issue via the [**project page**][dantro-project].
@@ -224,6 +225,8 @@ Contact the developers via: [`dantro-dev@iup.uni-heidelberg.de`][devmail] 


[utopia-project]: https://ts-gitlab.iup.uni-heidelberg.de/utopia/utopia



[dantro-joss-doi]: https://doi.org/10.21105/joss.02316



[pip]: https://pip.pypa.io/en/stable/

[pip-installation]: https://pip.pypa.io/en/stable/installing/

[conda]: https://conda.io/en/latest/

doc/how-to-cite.rst

0 → 100644
+14 −0
Original line number Diff line number Diff line 
.. _cite_dantro:



How to cite dantro?

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



If you are using ``dantro`` in your work, please cite the following publication:



.. admonition:: Citation Information



    Yunus Sevinchan, Benjamin Herdeanu, Jeremias Traub (2020).

    *dantro: a Python package for handling, transforming, and visualizing hierarchically structured data.* Journal of Open Source Software, 5(50), 2316.

    https://doi.org/10.21105/joss.02316



.. TODO Add copy-pasteable BiBtex here