proposed structure for 'recipes' repository

[jkingslake]

It seems like it wold be useful to have a repo to host ApRES-processing 'recipes' (see #1 and #2). This comment is to start off a discussion of the structure of such a repo.

A simple proposal for a structure for discussion:

README.md
|--[folder with short descriptive name of recipe 1]
|    |-- README.md (at a minimum describing what the code does, ideally describing how to use it, requirements, etc.)
|    |-- code
|           |-- script1.m
|           |-- script2.m
|           |
|--[folder with short descriptive name of recipe 2]
|    |-- README.md (at a minimum describing what the code does, ideally describing how to use it, requirements, etc.)
|    |-- code
|           |-- script1.py
|           |-- notebook1.ipynb
|           |

Having this as a minimum level of detail should give us the flexibility to add a much detail as we want to the recipes, but not require this from people, which risks putting people off contributing.

What do people think?

[Elizabethcase]

In addition in the README.md include name, email, date of use, and ideally a link or pointer to where someone could access a sample of the data you used. Perhaps we can make a template README?

For the structure, It could be useful to have the option (not required) of having an output (e.g, figures or processed file) & example directory, e.g.,

|-- folder
|    |-- README.md
|    |-- code
|    |-- output
|    |-- examples

[jkingslake]

Sounds good @Elizabethcase.

One question I have is how we should add code that is already conveniently in a repo of its own. For example, @irenavankova's code for computing time series of displacement. Seems silly to copy over the code. Maybe we just have the directory with a README which gives a brief description and provides a link to the existing repo?

[Elizabethcase]

Yeah that seems fine -- we were going to compile ApRES resources anyways, and it makes sense to compile recipes within the recipes repo, separately from theory/physical field use/papers/etc.

Alternatively, there are ways to transfer ownership of a personal repo to an organization. But I'm not sure everyone would want to do that.

[jkingslake]

OK, sounds good. I will label this thread as a To Do then.

[jkingslake]

autonomous-phase-sensitive-radar/apres-recipes#6 does this.

[jkingslake]

merged

[jkingslake]

@benhills wrote

For the code recipes I think it is easiest to expect that people self publish (can use zenodo) and then we link doi's from this repository in a readme or something. Could link relevant papers that way too.