added instructions about including a CITATION.cff file

CITATION.cff

@@ -0,0 +1,27 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: "Environmental Data Science Toolbox"
+message: "If you use this software, please cite it using the metadata from this file."
+type: software
+authors:
+    - name: "UK Centre for Ecology & Hydrology"
+      country: GB
+      website: "https://www.ceh.ac.uk/"
+    - given-names: Jeremy
+      family-names: Carter
+      name-suffix: PhD
+      email: [email protected]
+      affiliation: "UK Centre for Ecology & Hydrology"
+      orcid: 'https://orcid.org/0000-0003-1878-2277'
+repository-code: "https://github.com/NERC-CEH/data-science-toolbox"
+abstract: "This is a prototype version of the National Capability UK (NC-UK) Environmental Data Science Toolbox, hosted by the UK Centre for Ecology & Hydrology (UKCEH). The aim is to apply FAIR principles (Findable, Accessible, Interoperable, and Reusable) to a collection of data science methods that are generalizable across different environmental applications, with a focus on integrative modelling. The hope being that this will encourage cross-disciplinary use of methods, enhancing national environmental research."
+keywords:
+  - Environmental Science
+  - Data Science
+  - Jupyter Book
+url: "https://nerc-ceh.github.io/data-science-toolbox"
+license: tbd
+commit: c6cffeb
+date-released: '2025-11-03'

CONTRIBUTING.md

@@ -11,7 +11,7 @@ If you have a method that you think would be useful to include in the UKCEH Data
 ## Contributing a Method/Notebook:
 Here we'll go through the basic steps for contributing a method or notebook to the UKCEH Data Science Book. The process is designed to be simple and straightforward, allowing you to focus on developing your method or notebook without getting bogged down in technical details.
 
-1. [Create a standalone repository for the notebook/method](#create-standalone-repository). Upload the notebook and any necessary files to run it. Do this in the NERC-CEH GitHub organisation and follow the naming convention ds-toolbox-notebook-notebookname (e.g. ds-toolbox-notebook-bias-correction).
+1. [Create a standalone repository for the notebook/method](#create-standalone-repository). Upload the notebook and any necessary files to run it, as well as a [CITATION.cff](https://citation-file-format.github.io/) file. Do this in the NERC-CEH GitHub organisation and follow the naming convention ds-toolbox-notebook-notebookname (e.g. ds-toolbox-notebook-bias-correction).
 
 2. [Request collaborator access](#access) to the [data-science-toolbox repository](https://github.com/NERC-CEH/data-science-toolbox.git) - email [email protected]. 
 
@@ -76,7 +76,7 @@ A [Jupyter Book](https://jupyterbook.org/en/stable/intro.html) is an organised c
 ## Additional Detail:
 
 ### 1. Create a Standalone Repository for the Notebook/Method <a id='create-standalone-repository'></a>
-- Instead of housing the notebook in the data-science-toolbox repository, it is recommended to create a separate repository for the notebook/method. This helps keep the main repository clean and reduces its file size. The new repository can be created on GitHub and relevant files uploaded. Files might include the notebook itself, any modules that are used in the notebook, images and small data files, the yml file for creating the environment for running the notebook. The repository should be created in the NERC-CEH GitHub organisation and follow the naming convention ds-toolbox-notebook-notebookname (e.g. ds-toolbox-notebook-bias-correction).
+- Instead of housing the notebook in the data-science-toolbox repository, it is recommended to create a separate repository for the notebook/method. This helps keep the main repository clean and reduces its file size. The new repository can be created on GitHub and relevant files uploaded. Files might include the notebook itself, any modules that are used in the notebook, images and small data files, the yml file for creating the environment for running the notebook. A CITATION.cff file should be generated and stored in the root of the repository to allow for the notebook to be easily cited by others. It is advised to follow the [UKCEH best practice guidelines](https://github.com/NERC-CEH/repo-guidance/blob/main/cff-guidance/citation-cff_guidelines.md#the-citation-file-format-cff) for producing CITATION.cff files. The repository should be created in the NERC-CEH GitHub organisation and follow the naming convention ds-toolbox-notebook-notebookname (e.g. ds-toolbox-notebook-bias-correction).
 
 ### 2. Request Collaborator Access or Fork Repository <a id='access'></a>
 - If internal to UKCEH and wanting to contribute regularly to the project then request to become a collaborator on the GitHub repository or email me at [email protected]. If external to UKCEH it is currently advised to [create a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo), which is a remote copy of the repository to your personal GitHub account.

README.md

@@ -49,7 +49,15 @@ In terms of future content plans, there's various additional elements that could
 
 3. What about methodologies that are highly computationally demanding with long run-times? What's the computational back-end of the notebooks?
     - It's recommended that the notebooks should run top-to-bottom without error in <10 mins. In circumstances where it takes longer than this to perform inference on the model, it is recommended to include the code for inference but block comment it out and instead load in the output from a linked dataset. Currently users are expected to clone the repository containing the notebook and run the code locally in their favourite IDE, which means it's useful to limit the computational demands. In the future it's possible specific compute resource will be dedicated to the notebooks, allowing users to run the code in the cloud and without barriers associated with downloading relevant data and installing necessary packages.
-
+
+# How to Cite
+
+If you would like to cite the Environmental Data Science Jupyter Book, please use the "Cite this repository" button on this repository's landing page in the right sidebar. If you would like to cite an individual method's Jupyter Notebook, click on the "Notebook Repository" button at the top of the notebook and then use the "Cite this repository" button on that repository's landing page. See [here](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) for more information on how GitHub generates these citation buttons from `CITATION.cff` files.
+
+<p align="left">
+<img width="400" style="height: auto;" src="images/cite-repository-button.png" alt="Screenshot of 'Cite this repository' button on repository landing page">
+</p>
+
 > Inspired by the [Environmental Data Science book](https://edsbook.org/) produced by The Alan Turing Institute: EDS book community. Environmental Data Science book (Version v2025.7.1) [Computer software] 
 
 > Logo Credits: 
@@ -60,4 +68,3 @@ This Jupyter Book is being developed with accessibility in mind, following guide
 
 > Funding Statement:
 This research was supported by NERC, through the UKCEH National Capability for UK Challenges Programme NE/Y006208/1
-

_toc.yml

@@ -4,6 +4,10 @@
 format: jb-book
 root: intro
 parts:
+- caption: 
+  chapters:
+  - title: How to Cite
+    file: "cite"
 - caption: Methodology Notebooks
   chapters:
   - title: Bias Correction of Climate Models

cite.md

@@ -0,0 +1,7 @@
+# How to Cite
+
+If you would like to cite the Environmental Data Science Jupyter Book, please use the "Cite this repository" button on the [Toolbox repository's landing page](https://github.com/NERC-CEH/data-science-toolbox) in the right sidebar.
+
+If you would like to cite an individual method's Jupyter Notebook, click on the "Notebook Repository" button at the top of the notebook and then use the "Cite this repository" button on that repository's landing page.
+
+See [here](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) for more information on how GitHub generates these citation buttons from `CITATION.cff` files.