Remove Scipp-specifics, or make them optional?

[SimonHeybrock]

If we want to make this more widely usable, we should consider removing as many Scipp-specifics as possible, or least make them optional.

Start by addressing the simple and obvious, it does not have to be perfect in the first iteration!

Here is a list (maybe incomplete) of potential offenders:

$ grep -r scipp template/
template/CODE_OF_CONDUCT.md:scipp[at]ess.eu.
template/requirements/make_base.py:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/requirements/make_base.py:        org = "scipp"
template/requirements/make_base.py:    if repo == "scipp":
template/requirements/make_base.py:        base = "https://github.com/scipp/scipp/releases/download/nightly/scipp-nightly"
template/docs/about/index.md.jinja:Older versions of the documentation pages can be found under the assets of each [release](https://github.com/scipp/{{projectname}}/releases).
template/docs/about/index.md.jinja:{{prettyname}} is hosted and developed [on GitHub](https://github.com/scipp/{{projectname}}).
template/docs/conf.py.jinja:    'scipp': ('https://scipp.github.io/', None),
template/docs/conf.py.jinja:    'scipp._scipp.core.DataArray': 'scipp.DataArray',
template/docs/conf.py.jinja:    'scipp._scipp.core.Dataset': 'scipp.Dataset',
template/docs/conf.py.jinja:    'scipp._scipp.core.DType': 'scipp.DType',
template/docs/conf.py.jinja:    'scipp._scipp.core.Unit': 'scipp.Unit',
template/docs/conf.py.jinja:    'scipp._scipp.core.Variable': 'scipp.Variable',
template/docs/conf.py.jinja:    'scipp.core.data_group.DataGroup': 'scipp.DataGroup',
template/docs/conf.py.jinja:        {"name": "{{ link }}", "url": "https://scipp.github.io{% if link == 'Scipp' %}{% else %}/{{ link|lower }}{% endif %}"},
template/docs/conf.py.jinja:    "--Session.metadata=scipp_sphinx_build=True",
template/docs/conf.py.jinja:    import scipp as sc
template/docs/conf.py.jinja:# Using normalize whitespace because many __str__ functions in scipp produce
template/docs/_templates/doc_version.html:Current {{ project }} version: {{ version }} (<a href="https://github.com/scipp/{{ project|lower }}/releases">older versions</a>).
template/pyproject.toml.jinja:"Documentation" = "https://{{orgname}}.github.io{% if projectname != 'scipp' %}/{{projectname}}{% endif %}"
template/.github/dependabot.yml:  # noise in all template instances. Instead dependabot.yml in scipp/copier_template
template/.github/dependabot.yml:      - dependency-name: "scipp"
template/.github/workflows/ci.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/unpinned.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/test.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/nightly_at_main.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/docs.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/nightly_at_release.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/release.yml:# Copyright (c) 2023 Scipp contributors (https://github.com/scipp)
template/.github/workflows/release.yml:      - run: conda mambabuild --channel conda-forge --channel scipp --no-anaconda-upload --override-channels --output-folder conda/package conda
template/.github/workflows/release.yml:      - run: anaconda --token ${{ secrets.ANACONDATOKEN }} upload --user scipp --label main $(ls conda-package-noarch/*.tar.bz2)

[nvaytet]

Can you solve this by having a second template just for Scipp? (like we did with the ess template?)

[SimonHeybrock]

I think most of the above can be solved without a second template. And combining templates would become tricky if they touch the same file.

[nvaytet]

And combining templates would become tricky if they touch the same file.

Yes, I don't really know how that works.

[jl-wynen]

Concerning the copyright notices, we could just remove them. As I understand it, they are optional anyway. And copyrighting CI workflows, etc. doesn't gain us much.

[jokasimr]

Summary of the remaining scipp specifics:

# Makes sense to keep the email address here
  template/CODE_OF_CONDUCT.md:scipp[at]ess.eu.
# The org of the template is unchanged, so makes sense to keep
  template/.github/dependabot.yml:  # noise in all template instances. Instead dependabot.yml in scipp/copier_template
# Could remove / make optional
  template/.github/dependabot.yml:      - dependency-name: "scipp"
# Could ask in the questionnaire for the conda channel and user
  template/.github/workflows/release.yml:      - run: conda mambabuild --channel conda-forge --channel scipp --no-anaconda-upload --override-channels --output-folder conda/package conda
  template/.github/workflows/release.yml:      - run: anaconda --token ${{ secrets.ANACONDATOKEN }} upload --user scipp --label main $(ls conda-package-noarch/*.tar.bz2)
# This isn't really scipp specific, it doesn't do anything if the org is not 'scipp'
  template/requirements/make_base.py:        org = "scipp"
  template/requirements/make_base.py:    if repo == "scipp":
  template/requirements/make_base.py:        base = "https://github.com/scipp/scipp/releases/download/nightly/scipp-nightly"
# Could make this optional
  template/docs/conf.py.jinja:    'scipp': ('https://scipp.github.io/', None),
  template/docs/conf.py.jinja:    'scipp._scipp.core.DataArray': 'scipp.DataArray',
  template/docs/conf.py.jinja:    'scipp._scipp.core.Dataset': 'scipp.Dataset',
  template/docs/conf.py.jinja:    'scipp._scipp.core.DType': 'scipp.DType',
  template/docs/conf.py.jinja:    'scipp._scipp.core.Unit': 'scipp.Unit',
  template/docs/conf.py.jinja:    'scipp._scipp.core.Variable': 'scipp.Variable',
  template/docs/conf.py.jinja:    'scipp.core.data_group.DataGroup': 'scipp.DataGroup',
  template/docs/conf.py.jinja:    "--Session.metadata=scipp_sphinx_build=True",
  template/docs/conf.py.jinja:    import scipp as sc
  template/docs/conf.py.jinja:# Using normalize whitespace because many __str__ functions in scipp produce
# Doesn't do anything unless the projectname is 'scipp'
  template/pyproject.toml.jinja:"Documentation" = "https://{{orgname}}.github.io{% if projectname != 'scipp' %}/{{projectname}}{% endif %}"

I think the two main categories of scipp specifics that we could remove are:

• Anaconda release stuff
  • Could be made more generic. If we do make it generic it would be good to add docs about what the user needs to set up elsewhere to make it work (anaconda account / channel / secrets etc)
• Configurations in the docs build
  • Seems sensible to remove this if we want this more generic, but not sure how to do that

[SimonHeybrock]

We are already checking the org name in some places, can we make the above conditional if the org name is not scipp?

[jokasimr]

Yes we can make

• Anaconda release stuff
• Configurations in the docs build

conditional on the orgname being scipp